Type alias ReadableStreamDefaultReader<T>

Type declaration

• closed: Promise<void>

  a Promise that fulfills when the stream closes, or rejects if the stream throws an error or the reader's lock is released.

• cancel:function

  • cancel(reason?): Promise<void>

  • Cancel is used when you've completely finished with the stream and don't need any more data from it, even if there are chunks enqueued waiting to be read.

    Parameters

    • Optional reason: string

      A human-readable reason for the cancellation.

    Returns Promise<void>

    a Promise that resolves when the stream is canceled. Calling this method signals a loss of interest in the stream by a consumer.

    See

    https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader/cancel

• read:function

  • read(): Promise<ReadableStreamReadResult<T>>

  • Returns Promise<ReadableStreamReadResult<T>>

    a Promise providing access to the next chunk in the stream's internal queue.

    See

    https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader/read

• releaseLock:function

  • releaseLock(): void

  • Releases the reader's lock on the stream.

    Returns void

    See

    https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader/releaseLock