Subscribe to this event using the given listener. The listener will be invoked any time the event is emitted. The returned handle can be used to unsubscribe.
listener to subscribe
Optionaloptions: SubscribeOptions
options for the subscription, such as a signal that unsubscribes
handle to the subscription, can be used to unsubscribe
Create an iterator with the default options of this subscribable.
iterable/iterator
Create a subscribable that will apply the specified filter to any listeners added.
filtered Subscription
Create an iterator that supports async iteration of events emitted.
Optionaloptions: EventIteratorOptions
options for this iterator
iterable/iterator
Create a subscribable that changes the arguments of events before listeners receive them. The mapper returns the new arguments as an array, or a promise of the array:
const doubled = subscribable.map(n => [ n * 2 ]);
mapped Subscribable
Get a promise that will resolve the first time this event is fired after this call.
Optionaloptions: OnceOptions
options, such as a signal that stops the wait
promise that resolves the next time the event is fired
Subscribe to this event using the given listener. The listener will be invoked any time the event is emitted. The returned handle can be used to unsubscribe.
listener to subscribe
Optionaloptions: SubscribeOptions
options for the subscription, such as a signal that unsubscribes
handle to the subscription, can be used to unsubscribe
Create a Subscribable that changes the this argument used for listeners.
what should be treated as this for event listeners
modified Subscribable
Function that can be used to subscribe, filter and iterate over events. Subscribables are commonly fetched from an Event, adapted from another event emitters using createEventAdapter or manually created via createSubscribable.
Subscribing and unsubscribing
Subscribables are functions that allow them to be called directly to subscribe to the event:
It is also possible to subscribe/unsubscribe a listener using methods on the subscribable:
Filtering
Subscribables may be filtered to create an instance that only emits certain events:
Listening to something once
Listening for a single event may be done via once which returns a promise:
Async iteration of events
Subscribables can also be used with an async iterator to allow for event loops:
With default values:
Sometimes events are emitted faster than they can be consumed, limiting and controlling overflow of events can be done via
iterator().As an example this will limit to 10 queued events and then start dropping the earliest ones:
The behavior to use when the queue is full can be controlled by setting the overflow behavior to either
OverflowBehavior.DropNewestorOverflowBehavior.DropOldest.