Class History

Hierarchy

History

Index

Properties

Accessors

Methods

Properties

Private _pointer

_pointer: number = -1

Private _session

_session: string

Private _states

_states: IStateItem[] = []

Accessors

current

get current(): IStateItem

- Defined in packages/core/src/utils/history.ts:245
Get the current state.

Returns IStateItem

previous

get previous(): IStateItem | null

- Defined in packages/core/src/utils/history.ts:252
Get the previous state.

Returns IStateItem | null

size

get size(): number

- Defined in packages/core/src/utils/history.ts:259
Get the state size.

Returns number

Methods

Private _getAction

_getAction(trigger: Trigger): HistoryAction

- Defined in packages/core/src/utils/history.ts:266
Get the history action: push vs replace

Parameters
- trigger: Trigger
Returns HistoryAction

Private _getDirection

_getDirection(diff: number): Trigger

- Defined in packages/core/src/utils/history.ts:284
Get the direction of popstate change

Parameters
- diff: number
Returns Trigger

add

add(url: string, trigger: Trigger, action?: HistoryAction, data?: object): void

- Defined in packages/core/src/utils/history.ts:116
Add a new state.

Parameters
- url: string
- trigger: Trigger
- Optional action: HistoryAction
- Optional data: object
Returns void

change

change(url: string, trigger: Trigger, e?: LinkEvent | PopStateEvent): Trigger

- Defined in packages/core/src/utils/history.ts:88
Parameters
- url: string
- trigger: Trigger
- Optional e: LinkEvent | PopStateEvent
Returns Trigger

clear

clear(): void

- Defined in packages/core/src/utils/history.ts:216
Delete all states.

Returns void

get

get(index: number): IStateItem

- Defined in packages/core/src/utils/history.ts:231
Get state by index.

Parameters
- index: number
Returns IStateItem

init

init(url: string, ns: string): void

- Defined in packages/core/src/utils/history.ts:63
Init with first state.

Parameters
- url: string
- ns: string
Returns void

remove

remove(i?: number): void

- Defined in packages/core/src/utils/history.ts:203
Remove last state.

Parameters
- Optional i: number
Returns void

replace

replace(newStates: IStateItem[]): void

- Defined in packages/core/src/utils/history.ts:224
Replace all states.

Parameters
- newStates: IStateItem[]
Returns void

set

set(i: number, state: IStateItem): IStateItem

- Defined in packages/core/src/utils/history.ts:238
Set state by index.

Parameters
- i: number
- state: IStateItem
Returns IStateItem

store

store(data: object, i?: number): void

- Defined in packages/core/src/utils/history.ts:163
Store custom user data per state.

Parameters
- data: object
- Optional i: number
Returns void

update

update(data: any, i?: number): void

- Defined in packages/core/src/utils/history.ts:189
Update state.

Parameters
- data: any
- Optional i: number
Returns void

Generated using TypeDoc