Skip to main content
Version: Next

EventInterceptor

EventInterceptor

new EventInterceptor(client)
ParameterTypeOptional
clientClient

Properties

public client: any

Methods

public destroy(): void

Destroys the event interceptor.

public getGlobalHandlersCount(): number

Returns the number of global handlers.

public getSubscriberCount(event): number

Returns the number of subscribers for the event.

ParameterTypeOptionalDescription
eventkeyofClientEvents

public hasGlobalHandlers(): boolean

Whether the event has global handlers.

public hasSubscribers(event): boolean

Whether the event has subscribers.

ParameterTypeOptionalDescription
eventkeyofClientEvents

public subscribe(event, listener, options?): (

...args | unknown[ | ] ) => void Subscribes to an event.

ParameterTypeOptionalDescription
eventEventThe event to subscribe to.
listener( args: ClientEvents,[,Event,] ) => voidThe listener to call when the event is emitted.
optionsEventInterceptorContextData<Event>N/A

public unsubscribe(event, listener, reason?): void

Unsubscribes from an event.

ParameterTypeOptionalDescription
eventEventThe event to unsubscribe from.
listener( args: ClientEvents,[,Event,] ) => voidN/A
reasonstringN/A