Options
All
  • Public
  • Public/Protected
  • All
Menu

Type Parameters

  • TData = undefined

    Optional data object that's synchronized with the state.

Hierarchy

  • IEvent
    • ILiveStateEvents

Callable

  • ILiveStateEvents(event: "stateChanged", listener: ((state: string, data: undefined | TData, local: boolean) => void)): any
  • ILiveStateEvents(event: string, listener: ((...args: any[]) => void)): any
  • An LiveState objects state has changed.

    Parameters

    • event: "stateChanged"

      Name of event.

    • listener: ((state: string, data: undefined | TData, local: boolean) => void)

      Function called when event is triggered.

        • (state: string, data: undefined | TData, local: boolean): void
        • Parameters

          • state: string
          • data: undefined | TData
          • local: boolean

          Returns void

    Returns any

  • Event typings for LiveState class.

    Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

Generated using TypeDoc