Class DataStream

Utility class for readable data stream, intentionally named to disambiguate from ReadableStream, readable-stream, Readable etc.

Index

Constructors

Methods

duplicateDataStream fromBytes fromObject toBytes toObject

Constructors

constructor

new DataStream(): DataStream
Returns DataStream

Methods

`Static`duplicateDataStream

duplicateDataStream(dataStream, count): Readable[]
Duplicates the given data stream into the number of streams specified so that multiple handlers can consume the same data stream.
Parameters
- dataStream: Readable
- count: number
Returns Readable[]
- Defined in src/utils/data-stream.ts:89

`Static`fromBytes

fromBytes(bytes): Readable
Creates a readable stream from the bytes given.
Parameters
- bytes: Uint8Array
Returns Readable
- Defined in src/utils/data-stream.ts:57

`Static`fromObject

fromObject(object): Readable
Creates a readable stream from the object given.
Parameters
- object: Record<string, any>
Returns Readable
- Defined in src/utils/data-stream.ts:81

`Static`toBytes

toBytes(readableStream): Promise<Uint8Array>
Reads the entire readable stream given into array of bytes.
Parameters
- readableStream: Readable
Returns Promise<Uint8Array>
- Defined in src/utils/data-stream.ts:11

`Static`toObject

toObject(readableStream): Promise<object>
Reads the entire readable stream and JSON parses it into an object.
Parameters
- readableStream: Readable
Returns Promise<object>
- Defined in src/utils/data-stream.ts:30