Interface GoToOptions<T, N>

interface GoToOptions<T, N> {
    keys: undefined | (keyof T[N])[];
    merge: undefined | ((prevParams, nextParams) => T[N]);
    update: undefined | ((state) => void);
}

Type Parameters

  • T extends state

  • N extends keyof T

Properties

keys merge update

Properties

keys

keys: undefined | (keyof T[N])[]

Enables search for existing state using list of params keys. Empty list always creates new state. Nonempty list will be used to compare existing state params with passed ones. Params compared using strict equality.

merge

merge: undefined | ((prevParams, nextParams) => T[N])

Merges previous and next parameters on successful navigation to existing state.

Type declaration

    • (prevParams, nextParams): T[N]

    • Parameters

      • prevParams: T[N]
      • nextParams: T[N]

      Returns T[N]

update

update: undefined | ((state) => void)

Callback for further state update. Called after successful navigation.

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc