Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type Aliases

GetSynchronizationState<TState>: ((connecting: boolean) => TState | undefined)

Type Parameters

  • TState extends object

    Type of state object being synchronized.

Type declaration

    • (connecting: boolean): TState | undefined
    • Callback function used to the get the current state of an live object that's being synchronized.

      Parameters

      • connecting: boolean

        If true a "connect" message is being sent and the initial connecting state of the object is being requested.

      Returns TState | undefined

      The objects current state or undefined if not known or available.

LiveEventListener<TEvent>: ((evt: TEvent, local: boolean) => void)

Type Parameters

  • TEvent extends ILiveEvent

    Type of event being sent/received.

Type declaration

    • (evt: TEvent, local: boolean): void
    • Live event callback.

      Parameters

      • evt: TEvent

        The event that was sent/received.

      • local: boolean

        If true the evt is an event that was sent.

      Returns void

OutgoingLiveEvent<TEvent>: Omit<TEvent, "name" | "clientId" | "timestamp">

Removes the base properties from an event that derives from ILiveEvent.

Type Parameters

UpdateSynchronizationState<TState>: ((connecting: boolean, state: TState | undefined, senderId: string) => void)

Type Parameters

  • TState extends object

    Type of state object being synchronized.

Type declaration

    • (connecting: boolean, state: TState | undefined, senderId: string): void
    • Callback function used to the receive the state update sent by a remote live object.

      Parameters

      • connecting: boolean

        If true a "connect" message was received and state represents the remote objects initial state.

      • state: TState | undefined

        The remote object initial or current state.

      • senderId: string

        The clientId of the sender provider for role verification purposes.

      Returns void

Generated using TypeDoc