Class Events

A set of observables. You can bind events using individual observables or the methods emulating a subset Node's EventEmitter.

To maintain type safety, implementers define events as observable child properties.

Hierarchy (view full)

EventEmitter
- Events

Index

Constructors

Properties

commissioned decommissioned enabled$Changed fabricsChanged

Accessors

Methods

[dispose] addListener emit removeListener

Constructors

constructor

new Events(): Events
Returns Events
Inherited from EventEmitter.constructor

Properties

commissioned

commissioned: Observable<[context: ActionContext], void> = ...

decommissioned

decommissioned: Observable<[context: ActionContext], void> = ...

enabled$Changed

enabled$Changed: AsyncObservable<[context: ActionContext], void> = ...

fabricsChanged

fabricsChanged: Observable<[fabricIndex: FabricIndex, action: FabricAction], void> = ...

Accessors

eventNames

get eventNames(): string[]
Returns string[]
Inherited from EventEmitter.eventNames
- Defined in packages/general/dist/esm/util/Observable.d.ts:129

Methods

[dispose]

[dispose](): void
Returns void
Inherited from EventEmitter.[dispose]
- Defined in packages/general/dist/esm/util/Observable.d.ts:130

addListener

addListener<This, N>(this, name, handler): void
Type Parameters
- This
- N extends string
Parameters
- this: This
- name: N
- handler: ObserverOf<This, N>
Returns void
Inherited from EventEmitter.addListener
- Defined in packages/general/dist/esm/util/Observable.d.ts:127

emit

emit<This, N>(this, name, ...payload): void
Type Parameters
- This
- N extends string
Parameters
- this: This
- name: N
- Rest...payload: PayloadOf<This, N>
Returns void
Inherited from EventEmitter.emit
- Defined in packages/general/dist/esm/util/Observable.d.ts:126

removeListener

removeListener<This, N>(this, name, handler): void
Type Parameters
- This
- N extends string
Parameters
- this: This
- name: N
- handler: ObserverOf<This, N>
Returns void
Inherited from EventEmitter.removeListener
- Defined in packages/general/dist/esm/util/Observable.d.ts:128