Class Signal<THandler>

A signal is a way to publish and subscribe to events.

Typeparam

THandler The function signature to be implemented by handlers.

Type Parameters

THandler extends ((...args) => any)

Index

Constructors

Methods

connect disconnect disconnectAll emit emitCollecting getConnectionsCount hasConnections

Constructors

constructor

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

Methods

connect

connect(callback, options?): SignalConnection
Subscribe to this signal.
Parameters
- callback: THandler
  This callback will be run when emit() is called.
- options: ConnectOptions = {}
  Configure options for the connection
Returns SignalConnection
- Defined in Signal.ts:52

disconnect

disconnect(callback): 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
- Defined in Signal.ts:72

disconnectAll

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

Returns void
- Defined in Signal.ts:85

emit

emit(...args): void
Publish this signal event (call all handlers).
Parameters
- Rest ...args: Parameters<THandler>
Returns void
- Defined in Signal.ts:98

`Protected` emitCollecting

emitCollecting(collector, args): void
Parameters
- collector: Collector<THandler>
- args: Parameters<THandler>
Returns void
- Defined in Signal.ts:109

getConnectionsCount

getConnectionsCount(): number
Returns number
The number of connections on this signal.
- Defined in Signal.ts:35

hasConnections

hasConnections(): boolean
Returns boolean
true if this signal has connections.
- Defined in Signal.ts:42