Class QueueableEmitter<T>

Type Parameters

T

Hierarchy (View Summary)

Emitter<T[]>
- QueueableEmitter

Index

Constructors

Properties

_callbacks currentQueue?

Accessors

Methods

checkMaxListeners dispose fire popLeakingStack pushLeakingStack queue sequence

Constructors

constructor

new QueueableEmitter<T>(_options?: EmitterOptions): QueueableEmitter<T>
Type Parameters
- T
Parameters
- Optional_options: EmitterOptions
Returns QueueableEmitter<T>
Inherited from Emitter.constructor
- Defined in packages/core/src/common/event.ts:220

Properties

`Protected`_callbacks

_callbacks: undefined | CallbackList

`Optional`currentQueue

currentQueue?: T[]

Accessors

event

get event(): Event<T>
For the public to allow to subscribe to events from this Emitter

Returns Event<T>
Inherited from Emitter.event
- Defined in packages/core/src/common/event.ts:228

Methods

`Protected`checkMaxListeners

checkMaxListeners(maxListeners: number): undefined | (() => void)
Parameters
- maxListeners: number
Returns undefined | (() => void)
Inherited from Emitter.checkMaxListeners
- Defined in packages/core/src/common/event.ts:269

dispose

dispose(): void
Returns void
Inherited from Emitter.dispose
- Defined in packages/core/src/common/event.ts:345

fire

fire(): void
To be kept private to fire an event to subscribers

Returns void
Overrides Emitter.fire
- Defined in packages/core/src/common/event.ts:488

`Protected`popLeakingStack

popLeakingStack(stack: string): void
Parameters
- stack: string
Returns void
Inherited from Emitter.popLeakingStack
- Defined in packages/core/src/common/event.ts:313

`Protected`pushLeakingStack

pushLeakingStack(): () => void
Returns () => void
Inherited from Emitter.pushLeakingStack
- Defined in packages/core/src/common/event.ts:303

queue

queue(...arg: T[]): void
Parameters
- ...arg: T[]
Returns void
- Defined in packages/core/src/common/event.ts:481

sequence

sequence(
processor: (listener: (e: T[]) => any) => MaybePromise<boolean>,
): Promise<void>
Process each listener one by one. Return false to stop iterating over the listeners, true to continue.
Parameters
- processor: (listener: (e: T[]) => any) => MaybePromise<boolean>
Returns Promise<void>
Inherited from Emitter.sequence
- Defined in packages/core/src/common/event.ts:335