Class Emitter<T>

Type Parameters

T = any

Hierarchy (View Summary)

Emitter
- AsyncEmitter
- QueueableEmitter

Index

Constructors

Properties

Accessors

Methods

checkMaxListeners dispose fire popLeakingStack pushLeakingStack sequence

Constructors

constructor

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

Properties

`Protected`_callbacks

_callbacks: undefined | CallbackList

Accessors

event

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

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

Methods

`Protected`checkMaxListeners

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

dispose

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

fire

fire(event: T): any
To be kept private to fire an event to subscribers
Parameters
- event: T
Returns any
- Defined in packages/core/src/common/event.ts:325

`Protected`popLeakingStack

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

`Protected`pushLeakingStack

pushLeakingStack(): () => void
Returns () => void
- 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>
- Defined in packages/core/src/common/event.ts:335