Class Stream

Source: stream.ts

Extends

• EventEmitter<StreamEvents>

Constructors

Constructor

new Stream(): Stream

Returns

Stream

Inherited from

EventEmitter<StreamEvents>.constructor

Properties

SEND_EVENT

readonly static SEND_EVENT: "send" = "send"

---

START_EVENT

readonly static START_EVENT: "start" = "start"

---

STOP_EVENT

readonly static STOP_EVENT: "stop" = "stop"

---

enabled

enabled: boolean = false

Methods

on()

on<K>(event: K, listener: Listener<StreamEvents, K>): Listener<StreamEvents, K>

Starts listening to an event.

Type Parameters

K

K extends keyof StreamEvents

Parameters

event

K

The event to listen to.

listener

Listener<StreamEvents, K>

The function to call when the event is emitted.

Returns

Listener<StreamEvents, K>

The listener.

Inherited from

EventEmitter.on

---

once()

once<K>(event: K, listener: Listener<StreamEvents, K>): Listener<StreamEvents, K>

Registers an event listener that is automatically removed when called.

Type Parameters

K

K extends keyof StreamEvents

Parameters

event

K

The event to listen to.

listener

Listener<StreamEvents, K>

The function to call once the event is emitted.

Returns

Listener<StreamEvents, K>

The wrapped listener.

Inherited from

EventEmitter.once

---

onAsync()

onAsync<K>(event: K, listener: AsyncListener<StreamEvents, K>, onRejected?: (reason: any) => unknown | null): Listener<StreamEvents, K>

Starts listening to an event.

Type Parameters

K

K extends keyof StreamEvents

Parameters

event

K

The event to listen to.

listener

AsyncListener<StreamEvents, K>

The function to call when the event is emitted.

onRejected?

(reason: any) => unknown | null

Returns

Listener<StreamEvents, K>

The wrapped listener.

Inherited from

EventEmitter.onAsync

---

off()

off<K>(event: K, listener: Listener<StreamEvents, K>): void

Removes an event listener.

Type Parameters

K

K extends keyof StreamEvents

Parameters

event

K

The event to remove the listener from.

listener

Listener<StreamEvents, K>

The listener to remove.

Returns

void

Inherited from

EventEmitter.off

---

emit()

emit<K>(event: K, ...args: StreamEvents[K]): void

Emits an event to all its listeners.

Type Parameters

K

K extends keyof StreamEvents

Parameters

event

K

The event to emit.

args

...StreamEvents[K]

The arguments to pass to the listeners.

Returns

void

Inherited from

EventEmitter.emit

---

start()

start(callback?: (stream: this) => void): Stream

Parameters

callback?

(stream: this) => void

Returns

Stream

---

stop()

stop(): Stream

Returns

Stream

---

send()

send(text: string): Stream

Parameters

text

string

Returns

Stream