Class BuffersStream

Package version

This class generates a readable stream from the data in an array of buffers.

Hierarchy

any
- BuffersStream

Index

Constructors

constructor

Methods

_read

Constructors

constructor

new BuffersStream(buffers: Buffer[], byteLength: number, options?: BuffersStreamOptions): BuffersStream

- Defined in storage-common/src/BuffersStream.ts:28
Creates an instance of BuffersStream that will emit the data contained in the array of buffers.

Parameters
- buffers: Buffer[]
  
  Array of buffers containing the data
- byteLength: number
  
  The total length of data contained in the buffers
- Optional options: BuffersStreamOptions
Returns BuffersStream

Methods

_read

_read(size?: undefined | number): void

- Defined in storage-common/src/BuffersStream.ts:62
Internal _read() that will be called when the stream wants to pull more data in.

Parameters
- Optional size: undefined | number
  
  Optional. The size of data to be read
Returns void

Generated using TypeDoc