Class AsyncEmitter<T>

Type Parameters

T extends WaitUntilEvent

Hierarchy (View Summary)

Emitter<T>
- AsyncEmitter

Index

Constructors

Properties

_callbacks deliveryQueue

Accessors

Methods

checkMaxListeners deliver dispose fire popLeakingStack pushLeakingStack sequence

Constructors

constructor

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

Properties

`Protected`_callbacks

_callbacks: undefined | CallbackList

`Protected`deliveryQueue

deliveryQueue: undefined | Promise<void>

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

`Protected`deliver

deliver(
    listeners: Callback[],
    event: WaitUntilData<T>,
    token: CancellationToken,
    promiseJoin?: (p: Promise<any>, listener: Function) => Promise<any>,
): Promise<void>
Parameters
- listeners: Callback[]
- event: WaitUntilData<T>
- token: CancellationToken
- OptionalpromiseJoin: (p: Promise<any>, listener: Function) => Promise<any>
Returns Promise<void>
- Defined in packages/core/src/common/event.ts:436

dispose

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

fire

fire(
    event: WaitUntilData<T>,
    token?: CancellationToken,
    promiseJoin?: (p: Promise<any>, listener: Function) => Promise<any>,
): Promise<void>
Fire listeners async one after another.
Parameters
- event: WaitUntilData<T>
- token: CancellationToken = CancellationToken.None
- OptionalpromiseJoin: (p: Promise<any>, listener: Function) => Promise<any>
Returns Promise<void>
Overrides Emitter.fire
- Defined in packages/core/src/common/event.ts:423

`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

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