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[]) => any)

Hierarchy

Signal

Index

Constructors

Methods

connect disconnect disconnectAll emit emitCollecting getConnectionsCount hasConnections

Constructors

constructor

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

Methods

connect

connect(callback: THandler, order?: number): SignalConnection
Subscribe to this signal.
Parameters
- callback: THandler
  
  This callback will be run when emit() is called.
- order: number = 0
  
  Handlers with a higher order value will be called later.
Returns SignalConnection
- Defined in Signal.ts:39

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
- Defined in Signal.ts:59

disconnectAll

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

Returns void
- Defined in Signal.ts:73

emit

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

`Protected` emitCollecting

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

getConnectionsCount

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

Returns number
- Defined in Signal.ts:22

hasConnections

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

Returns boolean
- Defined in Signal.ts:29

Generated using TypeDoc