Class AsyncEmitter<T>

Type Parameters

T extends WaitUntilEvent

Hierarchy

Emitter<T>
- AsyncEmitter

Index

Constructors

constructor

Properties

Accessors

event

Methods

Constructors

constructor

new AsyncEmitter<T>(_options?: EmitterOptions): AsyncEmitter<T>

Inherited from Emitter.constructor
- Defined in packages/core/src/common/event.ts:172
Type Parameters
- T extends WaitUntilEvent
Parameters
- Optional _options: EmitterOptions
Returns AsyncEmitter<T>

Properties

Protected _callbacks

_callbacks: undefined | CallbackList

Protected deliveryQueue

deliveryQueue: undefined | Promise<void>

Accessors

event

get event(): Event<T>

Inherited from Emitter.event
- Defined in packages/core/src/common/event.ts:180
For the public to allow to subscribe to events from this Emitter

Returns Event<T>

Methods

Protected checkMaxListeners

checkMaxListeners(maxListeners: number): undefined | (() => void)

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

Protected deliver

deliver(listeners: Callback[], event: WaitUntilData<T>, token: CancellationToken, promiseJoin?: ((p: Promise<any>, listener: Function) => Promise<any>)): Promise<void>

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

dispose

dispose(): void

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

fire

fire(event: WaitUntilData<T>, token?: CancellationToken, promiseJoin?: ((p: Promise<any>, listener: Function) => Promise<any>)): Promise<void>

Overrides Emitter.fire
- Defined in packages/core/src/common/event.ts:375
Fire listeners async one after another.

Parameters
- event: WaitUntilData<T>
- token: CancellationToken = CancellationToken.None
- Optional promiseJoin: ((p: Promise<any>, listener: Function) => Promise<any>)
  - - (p: Promise<any>, listener: Function): Promise<any>
    - Parameters
      - p: Promise<any>
      - listener: Function
      Returns Promise<any>
Returns Promise<void>

Protected popLeakingStack

popLeakingStack(stack: string): void

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

Protected pushLeakingStack

pushLeakingStack(): (() => void)

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

sequence

sequence(processor: ((listener: ((e: T) => any)) => MaybePromise<boolean>)): Promise<void>

Inherited from Emitter.sequence
- Defined in packages/core/src/common/event.ts:287
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>)
  - - (listener: ((e: T) => any)): MaybePromise<boolean>
    - Parameters
      - listener: ((e: T) => any)
        (e: T): any
        Parameters
        e: T
        Returns any
      Returns MaybePromise<boolean>
Returns Promise<void>