Class Subscribable<F>

Type Parameters

F extends CallableFunction

Hierarchy (view full)

Subscribable

Index

Constructors

Accessors

Methods

registerProxy subscribe unregisterProxy unsubscribe

Constructors

constructor

new Subscribable<F>(): Subscribable<F>
Type Parameters
- F extends CallableFunction
Returns Subscribable<F>

Accessors

listeners

get listeners(): F[]
Returns F[]
- Defined in events/src/subscribable.ts:12

Methods

registerProxy

registerProxy(token, getListeners): void
This function is only used internally for proxies
Parameters
- token: any
- getListeners: GetListenersFn<F>
Returns void
- Defined in events/src/subscribable.ts:51

subscribe

subscribe(token, callback): void
Subscribe to the event / hook
Parameters
- token: any
  A token that can be used to unsubscribe from the event / hook later on
- callback: F
  A callback that will be invoked when the event / hook occurs
Returns void
- Defined in events/src/subscribable.ts:21

unregisterProxy

unregisterProxy(token): void
This function is only used internally for proxies
Parameters
- token: any
Returns void
- Defined in events/src/subscribable.ts:65

unsubscribe

unsubscribe(token): void
Remove a listener
Parameters
- token: any
  The token that was specified when subscribing to the listener. An invalid token does not result in an error.
Returns void
- Defined in events/src/subscribable.ts:39