Options
All
  • Public
  • Public/Protected
  • All
Menu

Keeps a record of the history of the App; it stores only the states of Pages

Hierarchy

Index

Constructors

constructor

Properties

app

app: IApp

The App the ManagerItem is attached to

config

config: ICONFIG

The Config of the App the ManagerItem is attached to

emitter

emitter: EventEmitter

The EventEmitter of the App the ManagerItem is attached to

key

key: any

The key to where ManagerItem is stored in an AdvancedManager

manager

The AdvancedManager the ManagerItem is attached to

pointer

pointer: number = -1

states

states: IState[]

Accessors

current

  • Get the current state

    Returns IState

last

  • Get the last state (top of the history stack).

    Returns IState

length

  • get length(): number
  • Returns number

previous

  • Get the previous state.

    Returns IState

Methods

add

  • Add a state to HistoryManager and change the history pushState data based on the historyAction specified

    Parameters

    • Optional value: IState
    • historyAction: "replace" | "push" = "push"

    Returns HistoryManager

boot

  • boot(...args: any): any
  • Called on start of Service

    Parameters

    • Rest ...args: any

    Returns any

get

  • Get a state based on it's index

    Parameters

    • index: number

    Returns IState

init

  • init(): void
  • Initializes the states array, and replace the history pushState data with the states array

    Returns void

initEvents

  • initEvents(): void
  • Initialize events

    Returns void

install

  • install(): any
  • Run after the Manager Item has been registered

    Returns any

register

remove

  • Parameters

    • Optional index: number

    Returns HistoryManager

replace

  • Replaces the states array with another states array, this is later used when going back and forward in page history

    Parameters

    Returns HistoryManager

set

  • Set state by index.

    Parameters

    Returns IState

stop

  • stop(): void
  • Stop Service

    Returns void

stopEvents

  • stopEvents(): void
  • Stop events

    Returns void

uninstall

  • uninstall(): any
  • Run before the ManagerItem has been unregistered

    Returns any

unregister

  • unregister(): void
  • Basically removes a ManagerItem, in order to recover the ManagerItem, it needs to be re-added to an AdvancedManager

    Returns void

Generated using TypeDoc