Class GouterState<T, N>

constructor

• new GouterState<T, N>(name, params, stack?, focusedIndex?): GouterState<T, N>

• Creates GouterState using required name, params and optional stack.

  Type Parameters

  • T extends GouterConfig = GouterConfig

  • N extends string | number | symbol = keyof T

  Parameters

  • name: N

    string to distinguish states

  • params: T[N]

    collection of parameters to customize states

  • Optional stack: GouterState<T, keyof T>[]

    optional list of inner states

  • Optional focusedIndex: number

    optional index of focused state in stack

  Returns GouterState<T, N>

Readonly focusedIndex

Readonly name

Readonly params

Readonly stack

Static emptyStack

Static focusingStates

Static listenersByState

Static modifiedStates

Static parentByState

Static rootStates

Static schedulerReady

focusedChild

• get focusedChild(): undefined | GouterState<T, keyof T>

• Focused state from this state stack when the stack is not empty, undefined otherwise.

  Returns undefined | GouterState<T, keyof T>

isFocused

• get isFocused(): boolean

• True when this state has a parent and it's focusedIndex points to this state.

  Returns boolean

parent

• get parent(): undefined | GouterState<T, keyof T>

• Parent state when this state in a stack, undefined otherwise.

  Returns undefined | GouterState<T, keyof T>

clone

• clone(): GouterState<T, N>

• Deeply clones this state without listeners. Automatically called when some state with parent put into another stack during setStack call.

  Returns GouterState<T, N>

focus

• focus(): GouterState<T, N>

• Focuses on this state by recursively changing focusedIndex of it's parents. If it has no parent or parent focusedIndex is same then nothing happens.

  Returns GouterState<T, N>

listen

• listen(listener): (() => void)

• Adds this listener of router state changes to set of listeners and returns unlisten callback. Every listener will be called on each update of params, stack and/or focusedIndex.

  Parameters

  • listener: GouterListener<T, N>

  Returns (() => void)

  unlisten callback

  • • (): void

    • Returns void

mergeParams

• mergeParams(partialParams): GouterState<T, N>

• Merges partial params into current params.

  Parameters

  • partialParams: Partial<T[N]>

  Returns GouterState<T, N>

remove

• remove(): GouterState<T, N>

• Removes current state from it's parent stack or does nothing if it has no parent.

  Returns GouterState<T, N>

replace

• replace<R>(state): GouterState<T, R>

• Replaces current state fields including name, params, stack and focusedIndex.

  Type Parameters

  • R extends string | number | symbol

  Parameters

  • state: GouterState<T, R>

  Returns GouterState<T, R>

setFocusedIndex

• setFocusedIndex(focusedIndex): GouterState<T, N>

• Focuses on stack state with provided focusedIndex. If that index is same as before or stack state is not found then nothing happens.

  Parameters

  • focusedIndex: number

  Returns GouterState<T, N>

setParams

• setParams(params): GouterState<T, N>

• Sets current params.

  Parameters

  • params: T[N]

  Returns GouterState<T, N>

setStack

• setStack(stack): GouterState<T, N>

• Replaces current stack. It also resets current focusedIndex to last stack state index so if you need to preserve or modify that index you should call focus on some stack state before this operation. If some state in new stack already has parent then it will be cloned using clone.

  Parameters

  • stack: GouterState<T, keyof T>[]

  Returns GouterState<T, N>

withFocus

• withFocus(): GouterState<T, N>

• Adds this state to special set of focusing states. During parent setStack call it will be automatically focused only once and then removed from focusing states. If two or more focusing states occur in same stack then last one will be focused.

  Returns GouterState<T, N>

Static notify

• notify(): void

• Notifies every listener of currently modified states about changes. Modified states could be added using GouterState.schedule.

  Returns void

  See

  GouterState.notify

Static schedule

• schedule(state): void

• Adds state to modified states. That states' listeners will be called using GouterState.notify.

  Parameters

  • state: GouterState<GouterConfig, any>

  Returns void