Skip to content

events ​

String-keyed event channels with EventEmitter.

Import

ts
import { EventEmitter } from "events";

EventEmitter class ​

ts
class EventEmitter

EventEmitter.emit ​

ts
emit(event: string, ...args: any[]): boolean

Emit an event, calling all registered listeners with the provided arguments.

Parameters

  • event: The event name.
  • args: Arguments passed to each listener.

Returns: true if any listeners were called, false otherwise.

EventEmitter.listenerCount ​

ts
listenerCount(event: string): int

Get the number of listeners registered for an event.

Parameters

  • event: The event name.

Returns: The count of both on and once listeners.

EventEmitter.off ​

ts
off(event: string, listener: Function): boolean

Remove one registration of listener. True when one was removed.

EventEmitter.on ​

ts
on(event: string, listener: Function): Function

Add a persistent listener. Returns a function that removes it.

EventEmitter.once ​

ts
once(event: string, listener: Function): Function

Add a listener that fires once. Returns a function that removes it.

EventEmitter.removeAllListeners ​

ts
removeAllListeners(event?: string): void

Remove all listeners for a specific event, or all listeners for all events.

Parameters

  • event: Optional event name; if omitted, clears all events.

Generated from lang/types/events.d.tks in the ThicketScript repository.