kernel/events/emitter
Classes
Section titled “Classes”Emitter
Section titled “Emitter”Defined in: app/src/kernel/events/emitter.ts:26
Owns an Event and fires it. Listeners added or removed while an event is being
delivered take effect from the next fire.
Type Parameters
Section titled “Type Parameters”T
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Emitter<
T>(options?):Emitter<T>
Defined in: app/src/kernel/events/emitter.ts:32
Parameters
Section titled “Parameters”options?
Section titled “options?”EmitterOptions = {}
Error handling for listeners.
Returns
Section titled “Returns”Emitter<T>
Properties
Section titled “Properties”
readonlyevent:Event<T>
Defined in: app/src/kernel/events/emitter.ts:37
The event that consumers subscribe to.
Accessors
Section titled “Accessors”listenerCount
Section titled “listenerCount”Get Signature
Section titled “Get Signature”get listenerCount():
number
Defined in: app/src/kernel/events/emitter.ts:48
Number of subscribed listeners.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: app/src/kernel/events/emitter.ts:75
Removes all listeners; later subscriptions are ignored.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”fire()
Section titled “fire()”fire(
value):void
Defined in: app/src/kernel/events/emitter.ts:56
Delivers a value to every listener.
Parameters
Section titled “Parameters”T
The value to deliver.
Returns
Section titled “Returns”void
Interfaces
Section titled “Interfaces”EmitterOptions
Section titled “EmitterOptions”Defined in: app/src/kernel/events/emitter.ts:14
Options for an Emitter.
Properties
Section titled “Properties”onListenerError?
Section titled “onListenerError?”
readonlyoptionalonListenerError?: (error) =>void
Defined in: app/src/kernel/events/emitter.ts:19
Called when a listener throws. The remaining listeners still run. Without a handler, the first error is rethrown after all listeners ran.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”void
Type Aliases
Section titled “Type Aliases”Event<
T> = (listener) =>Disposable
Defined in: app/src/kernel/events/emitter.ts:11
Subscribes a listener. Services expose their change notifications as events, for
example settings.onDidChange(listener).
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”listener
Section titled “listener”Listener<T>
Returns
Section titled “Returns”A disposable that removes the listener.
Listener
Section titled “Listener”Listener<
T> = (value) =>void
Defined in: app/src/kernel/events/emitter.ts:4
Receives the values of an Event.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”void