Class StreamFramedWriter

FramedWriter backed by a WritableStream of bytes.

Implements

FramedWriter

Index

Constructors

Methods

close release write writeLine

Constructors

constructor

new StreamFramedWriter(
stream: WritableStream<Uint8Array<ArrayBufferLike>>,
): StreamFramedWriter
Parameters
- stream: WritableStream<Uint8Array<ArrayBufferLike>>
Returns StreamFramedWriter
- Defined in src/core/framing.ts:234

Methods

close

close(): Promise<void>
Closes the writable side.

Returns Promise<void>
Implementation of FramedWriter.close
- Defined in src/core/framing.ts:246

release

release(): void
Releases the underlying stream lock without closing the stream.

Used when a starttls upgrade swaps the socket: the old writer must relinquish its lock so the new socket's streams can be locked, without closing the (discarded) old stream.

Returns void
- Defined in src/core/framing.ts:262

write

write(chunk: Uint8Array): Promise<void>
Writes a chunk of bytes.
Parameters
- chunk: Uint8Array
Returns Promise<void>
Implementation of FramedWriter.write
- Defined in src/core/framing.ts:238

writeLine

writeLine(s: string): Promise<void>
Writes s as UTF-8 followed by CRLF.
Parameters
- s: string
Returns Promise<void>
Implementation of FramedWriter.writeLine
- Defined in src/core/framing.ts:242