@litert/websocket

Appearance

Documents for @litert/websocket / Decl / IMessageReadStream

Interface: IMessageReadStream ​

Defined in: src/lib/Decl.ts:229

The interface of websocket message reader, implements Readable stream.

Extends ​

Properties ​

mode ​

readonly mode: STANDARD

Defined in: src/lib/Decl.ts:235

The mode of receiving frames. Only and always for EFrameReceiveMode.STANDARD.

Overrides ​

IMessage.mode

opcode ​

readonly opcode: EOpcode

Defined in: src/lib/Decl.ts:240

The opcode of this message.

Overrides ​

IMessage.opcode

Methods ​

toBuffer() ​

toBuffer(): Promise<Buffer<ArrayBufferLike>>

Defined in: src/lib/Decl.ts:250

Read all data in this message as a single buffer.

Returns ​

Promise<Buffer<ArrayBufferLike>>

toBufferArray() ​

toBufferArray(): Promise<Buffer<ArrayBufferLike>[]>

Defined in: src/lib/Decl.ts:255

Read all data in this message as an array of buffers, without copying data.

Returns ​

Promise<Buffer<ArrayBufferLike>[]>

toString() ​

toString(): Promise<string>

Defined in: src/lib/Decl.ts:245

Read all data in this message as a string.

Returns ​

Promise<string>