Skip to content

editorGlobalsIPublicEventEmitterInterface

Interface: IPublicEventEmitterInterface ‹CallbackArgumentType

The event emitter interface that can be exposed to other classes that want to listen to this event.

Type parameters

CallbackArgumentType

Hierarchy

  • IPublicEventEmitterInterface

Implemented by

Index

Methods

Methods

deregister

deregister(receiver: object, callback: function): any

Defined in src/util/EventEmitter.ts:198

De-registers all event listeners that match the receiver and callback method

Parameters:

receiver: object

object that has (as in: property) the callback method

callback: function

the callback method to be called when the event is fired

▸ (CallbackArgumentType: any, emitter?: IEmittingEventEmitter): void

Parameters:

Name Type
CallbackArgumentType any
emitter? IEmittingEventEmitter

Returns: any


getNextEmitPromise

getNextEmitPromise(): Promise‹void›

Defined in src/util/EventEmitter.ts:203

Returns a pending promise, that will resolve when this emitter emits the next time after this call.

Returns: Promise‹void›


register

register(receiver: object, callback: function): any

Defined in src/util/EventEmitter.ts:191

Register an event listener. Multiple event listener per receiver/callback are possible

Parameters:

receiver: object

object that has (as in: property) the callback method

callback: function

the callback method to be called when the event is fired

▸ (CallbackArgumentType: any, emitter?: IEmittingEventEmitter): void

Parameters:

Name Type
CallbackArgumentType any
emitter? IEmittingEventEmitter

Returns: any


setSilenced

setSilenced(increase?: boolean): void

Defined in src/util/EventEmitter.ts:208

In/decrease silence counter, will not emit while it's gt 0.

Parameters:

Name Type
increase? boolean

Returns: void