Class AsyncEmitter<T>

Type Parameters

T extends WaitUntilEvent

Hierarchy (view full)

Emitter<T>
- AsyncEmitter

Index

Constructors

constructor

new AsyncEmitter<T>(_options?): 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): 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, event, token, promiseJoin?): Promise<void>
Parameters
- listeners: Callback[]
- event: WaitUntilData<T>
- token: CancellationToken
- Optional promiseJoin: ((p, listener) => Promise<any>)
  - - (p, listener): Promise<any>
    - Parameters
      p: Promise<any>
      listener: Function
      Returns 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, token?, promiseJoin?): Promise<void>
Fire listeners async one after another.
Parameters
- event: WaitUntilData<T>
- token: CancellationToken = CancellationToken.None
- Optional promiseJoin: ((p, listener) => Promise<any>)
  - - (p, listener): Promise<any>
    - Parameters
      p: Promise<any>
      listener: Function
      Returns Promise<any>
Returns Promise<void>
Overrides Emitter.fire
- Defined in packages/core/src/common/event.ts:423

`Protected` popLeakingStack

popLeakingStack(stack): 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)
- - (): void
  - Returns void
Inherited from Emitter.pushLeakingStack
- Defined in packages/core/src/common/event.ts:303

sequence

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

Class AsyncEmitter<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AsyncEmitter<T>

Properties

Protected _callbacks

Protected deliveryQueue

Accessors

event

Returns Event<T>

Methods

Protected checkMaxListeners

Parameters

Returns undefined | (() => void)

Protected deliver

Parameters

Parameters

Returns Promise<any>

Returns Promise<void>

dispose

Returns void

fire

Parameters

Parameters

Returns Promise<any>

Returns Promise<void>

Protected popLeakingStack

Parameters

Returns void

Protected pushLeakingStack

Returns (() => void)

Returns void

sequence

Parameters

Parameters

Parameters

Returns any

Returns MaybePromise<boolean>

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Protected` _callbacks

`Protected` deliveryQueue

`Protected` checkMaxListeners

`Protected` deliver

`Protected` popLeakingStack

`Protected` pushLeakingStack