Class Signal<THandler>

Type Parameters

  • THandler extends ((...args: any[]) => any)

Hierarchy

  • Signal

Constructors

constructor

Properties

connectionsCount decrementConnectionCount emitDepth hasNewLinks head unsetNewLink

Methods

connect disconnect disconnectAll emit emitCollecting getConnectionsCount hasConnections

Constructors

constructor

  • Type Parameters

    • THandler extends ((...args: any[]) => any)

    Returns Signal<THandler>

Properties

Private connectionsCount

connectionsCount: any

Private decrementConnectionCount

decrementConnectionCount: any

Private emitDepth

emitDepth: any

Private hasNewLinks

hasNewLinks: any

Private Readonly head

head: any

Private unsetNewLink

unsetNewLink: any

Methods

connect

  • Subscribe to this signal.

    Parameters

    • callback: THandler

      This callback will be run when emit() is called.

    • Optional order: number

      Handlers with a higher order value will be called later.

    Returns SignalConnection

disconnect

  • Unsubscribe from this signal with the original callback instance. While you can use this method, the SignalConnection returned by connect() will not be updated!

    Parameters

    • callback: THandler

      The callback you passed to connect().

    Returns boolean

disconnectAll

  • Disconnect all handlers from this signal event.

    Returns void

emit

  • Publish this signal event (call all handlers).

    Parameters

    • Rest ...args: Parameters<THandler>

    Returns void

Protected emitCollecting

  • Parameters

    • collector: Collector<THandler>
    • args: Parameters<THandler>

    Returns void

getConnectionsCount

  • Returns

    The number of connections on this signal.

    Returns number

hasConnections

  • Returns

    true if this signal has connections.

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc