Class Stream

Source: stream.ts

Extends

• EventEmitter<typeof StreamEvents>

Constructors

Constructor

new Stream(): Stream

Returns

Stream

Inherited from

EventEmitter<typeof StreamEvents>.constructor

Methods

emit()

emit<Key>(eventName: Key, data?: unknown): void

Dispatch event

Type Parameters

Key

Key extends "stop" | "new" | "start"

Parameters

eventName

Key

data?

unknown

Returns

void

Inherited from

EventEmitter.emit

---

off()

off<Key>(eventName: Key, callback: Listener): void

Remove event listener for an event

Type Parameters

Key

Key extends "stop" | "new" | "start"

Parameters

eventName

Key

callback

Listener

Returns

void

Inherited from

EventEmitter.off

---

on()

on<Key>(eventName: Key, callback: Listener): Listener

Add event listener for an event

Type Parameters

Key

Key extends "stop" | "new" | "start"

Parameters

eventName

Key

callback

Listener

Returns

Listener

Inherited from

EventEmitter.on

---

send()

send(text: string): Stream

Parameters

text

string

Returns

Stream

---

start()

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

Parameters

callback?

(stream: this) => void

Returns

Stream

---

stop()

stop(): Stream

Returns

Stream

Properties

enabled

enabled: boolean = false

---

EVENT_NAMES

static EVENT_NAMES: { new: "new"; start: "start"; stop: "stop"; } = StreamEvents

new

readonly new: "new" = "new"

start

readonly start: "start" = "start"

stop

readonly stop: "stop" = "stop"

Overrides

EventEmitter.EVENT_NAMES