lspeasy / core/src / TransportEventEmitter

Class: TransportEventEmitter

Defined in: packages/core/src/transport/events.ts:18

Transport event emitter

Extends

• DisposableEventEmitter<TransportEventMap>

Constructors

Constructor

new TransportEventEmitter(): TransportEventEmitter;

Returns

TransportEventEmitter

Inherited from

DisposableEventEmitter.constructor

Methods

dispose()

dispose(): void;

Defined in: packages/core/src/utils/disposable-event-emitter.ts:114

Dispose all listeners and prevent further registrations.

Returns

void

Inherited from

DisposableEventEmitter.dispose

---

emit()

emit<K>(event, ...args): void;

Defined in: packages/core/src/utils/disposable-event-emitter.ts:96

Emit an event to all registered listeners in registration order.

Type Parameters

Type Parameter
K extends keyof TransportEventMap

Parameters

Parameter	Type	Description
event	K	The event name to emit.
...args	TransportEventMap[K]	Arguments forwarded to each listener in the order they match TEvents[K].

Returns

void

Inherited from

DisposableEventEmitter.emit

---

emitConnect()

emitConnect(): void;

Defined in: packages/core/src/transport/events.ts:22

Emit connect event

Returns

void

---

emitDisconnect()

emitDisconnect(): void;

Defined in: packages/core/src/transport/events.ts:29

Emit disconnect event

Returns

void

---

emitError()

emitError(error): void;

Defined in: packages/core/src/transport/events.ts:36

Emit error event

Parameters

Parameter	Type
error	Error

Returns

void

---

emitMessage()

emitMessage(message): void;

Defined in: packages/core/src/transport/events.ts:43

Emit message event

Parameters

Parameter	Type
message	Message

Returns

void

---

on()

on<K>(event, listener): Disposable;

Defined in: packages/core/src/utils/disposable-event-emitter.ts:28

Register a listener and receive a disposable to unregister it.

Type Parameters

Type Parameter
K extends keyof TransportEventMap

Parameters

Parameter	Type	Description
event	K	The event name to subscribe to.
listener	Listener<TransportEventMap, K>	Callback invoked each time event is emitted.

Returns

Disposable

A Disposable — call dispose() to remove the listener.

Inherited from

DisposableEventEmitter.on

---

once()

once<K>(event, listener): Disposable;

Defined in: packages/core/src/utils/disposable-event-emitter.ts:62

Register a one-time listener that automatically unregisters after first emission.

Type Parameters

Type Parameter
K extends keyof TransportEventMap

Parameters

Parameter	Type	Description
event	K	The event name to subscribe to.
listener	Listener<TransportEventMap, K>	Callback invoked once the next time event is emitted.

Returns

Disposable

A Disposable — call dispose() to cancel before the event fires.

Inherited from

DisposableEventEmitter.once