Class VcsEvent<T>

Type Parameters

T

Index

Accessors

numberOfListeners

Constructors

Methods

addEventListener awaitRaisedEvent destroy raiseEvent removeEventListener

Accessors

numberOfListeners

get numberOfListeners(): number
The number of listeners

Returns number
- Defined in src/vcsEvent.ts:9

Constructors

constructor

new VcsEvent<T>(): VcsEvent<T>
Type Parameters
- T
Returns VcsEvent<T>

Methods

addEventListener

addEventListener(listener: Listener<T>): () => void
Adds an event listener. An event listener can only be added once. A listener added multiple times will only be called once.
Parameters
- listener: Listener<T>
Returns () => void
- remove callback. call this function to remove the listener
- Defined in src/vcsEvent.ts:19

awaitRaisedEvent

awaitRaisedEvent(event: T): Promise<void>
Parameters
- event: T
Returns Promise<void>
- Defined in src/vcsEvent.ts:54

destroy

destroy(): void
clears all listeners

Returns void
- Defined in src/vcsEvent.ts:70

raiseEvent

raiseEvent(event: T): void
Raise the event, calling all listeners, if a listener is removed in between calling listeners, the listener is not called.
Parameters
- event: T
Returns void
- Defined in src/vcsEvent.ts:45

removeEventListener

removeEventListener(listener: Listener<T>): boolean
Removes the provided listener
Parameters
- listener: Listener<T>
Returns boolean
- whether a listener was removed
- Defined in src/vcsEvent.ts:31