ToMaskOptions type | TanStack Router Docs

The ToMaskOptions type includes the same destination fields as ToOptions, excluding mask, and adds options specific to route masking.

tsx

type ToMaskOptions = {
  from?: ValidRoutePath | string
  to?: ValidRoutePath | string
  hash?: true | string | ((prev?: string) => string)
  state?: true | HistoryState | ((prev: HistoryState) => HistoryState)
} & SearchParamOptions &
  PathParamOptions & {
    unmaskOnReload?: boolean
  }

type ToMaskOptions = {
  from?: ValidRoutePath | string
  to?: ValidRoutePath | string
  hash?: true | string | ((prev?: string) => string)
  state?: true | HistoryState | ((prev: HistoryState) => HistoryState)
} & SearchParamOptions &
  PathParamOptions & {
    unmaskOnReload?: boolean
  }

ToOptions