A readable stream

interface IReadable {
    read: (into: Uint8Array) => Promise<number>;
}

Hierarchy (View Summary)

Implemented by

Properties

Properties

read: (into: Uint8Array) => Promise<number>

Read data from the underlying source into the provided Uint8Array, up to the length of the array, and return the number of bytes read.

If there are no bytes available currently, the implementation is supposed to wait until at least one byte is available, and only then resolve the promise. Resolving the promise with a zero-length Uint8Array is marking the end of the source.

Type declaration

    • (into: Uint8Array): Promise<number>
    • Parameters

      • into: Uint8Array

      Returns Promise<number>

      Uint8Array containing the bytes that were read.