Class Signal<THandler>

Type Parameters

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

Index

Constructors

Methods

connect disconnect disconnectAll emit emitCollecting getConnectionsCount hasConnections

Constructors

constructor

new Signal<THandler extends (...args: any[]) => any>(): Signal<THandler>
Type Parameters
- THandler extends (...args: any[]) => any
Returns Signal<THandler>

Methods

connect

connect(callback: THandler, options?: ConnectOptions): SignalConnection
Subscribe to this signal.
Parameters
- callback: THandler
  This callback will be run when emit() is called.
- Optionaloptions: ConnectOptions
  Configure options for the connection
Returns SignalConnection

disconnect

disconnect(callback: THandler): boolean
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

disconnectAll(): void
Disconnect all handlers from this signal event.

Returns void

emit

emit(...args: Parameters<THandler>): void
Publish this signal event (call all handlers).
Parameters
- ...args: Parameters<THandler>
Returns void

`Protected`emitCollecting

emitCollecting(collector: Collector<THandler>, args: Parameters<THandler>): void
Parameters
- collector: Collector<THandler>
- args: Parameters<THandler>
Returns void

getConnectionsCount

getConnectionsCount(): number
Returns number
The number of connections on this signal.

hasConnections

hasConnections(): boolean
Returns boolean
true if this signal has connections.