Namespace ReadStreamUtil

Additional Readstream util

Index

Functions

Functions

all

all(stream: ReadStream): Promise<Uint8Array>

- Defined in stream/index.ts:76
Read every data to end of stream.

Parameters
- stream: ReadStream
Returns Promise<Uint8Array>

copy

copy(read: ReadStream, write: WriteStream): Promise<number>

- Defined in stream/index.ts:125
Write every read data from ReadStream to WriteStream.

Parameters
- read: ReadStream
  
  Stream to be read
- write: WriteStream
  
  Stream to be written
Returns Promise<number>

Bytes written.

exact

exact(stream: ReadStream, size: number): Promise<Uint8Array | null>

- Defined in stream/index.ts:103
Read exact size bytes into Uint8Array or null if the stream ends before to fill all.

Parameters
- stream: ReadStream
- size: number
Returns Promise<Uint8Array | null>

iter

iter(stream: ReadStream, size?: number): AsyncIterableIterator<Uint8Array>

- Defined in stream/index.ts:54
Create AsyncIterableIterator which read stream buffers up to size bytes.

Parameters
- stream: ReadStream
- size: number = 65535
Returns AsyncIterableIterator<Uint8Array>

Generated using TypeDoc