Type alias ReadableStream<T>

Type declaration

• 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.

  Returns

  a Promise that resolves when the stream is canceled.

  See

  https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/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

      Returns Promise<void>

      a Promise that resolves when the stream is canceled.

      See

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

• getReader:function

  • getReader(): ReadableStreamDefaultReader<T>

  • Creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

    Returns ReadableStreamDefaultReader<T>

    See

    https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/getReader

  • getReader(options): unknown

  • Parameters

    • options: {
          mode: "byob";
      }

      • mode: "byob"

    Returns unknown