ReadableStream

Overview

The ReadableStream interface of the Streams API represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.

This class implementation polyfills ReadableStream in the Cloudflare Pages environment.

Usage

Node

import { ReadableStream } from 'keywork/polyfills/worker/ReadableStream'

Deno

import { ReadableStream } from 'https://deno.land/x/keywork/polyfills/worker/ReadableStream'

Browser/ESM

let { ReadableStream } = await import('https://esm.sh/keywork/polyfills/worker/ReadableStream')

Type parameters

Name	Type
R	any

Implements

• ReadableStream<R>

Constructors

constructor

new ReadableStream

new ReadableStream<R>(underlyingSource?, _queuingStrategy?)

Type parameters

Name	Type
R	any

Parameters

Name	Type
underlyingSource?	any
_queuingStrategy?	Object
_queuingStrategy.highWaterMark?	number
_queuingStrategy.size?	undefined

Defined in

polyfills/worker/ReadableStream/mod.ts:94

Accessors

locked

get locked

(): `boolean`

Returns

boolean

Implementation of

globalThis.ReadableStream.locked

Defined in

polyfills/worker/ReadableStream/mod.ts:108

Methods

[asyncIterator]

[asyncIterator]

(_options?): `AsyncIterableIterator<any>`

Parameters

Name	Type
_options?	any

Returns

AsyncIterableIterator<any>

Defined in

polyfills/worker/ReadableStream/mod.ts:146

cancel

cancel

(reason?): `Promise<void>`

Parameters

Name	Type
reason?	any

Returns

Promise<void>

Implementation of

globalThis.ReadableStream.cancel

Defined in

polyfills/worker/ReadableStream/mod.ts:112

getReader

getReader

(options?): `any`

Parameters

Name	Type
options?	unknown

Returns

any

Implementation of

globalThis.ReadableStream.getReader

Defined in

polyfills/worker/ReadableStream/mod.ts:116

pipeThrough

pipeThrough

pipeThrough<T>(__namedParameters, options?): [`ReadableStream<`T`>`](ReadableStream.mdx)

Type parameters

Name
T

Parameters

Name	Type
__namedParameters	Object
__namedParameters.readable	ReadableStream<T>
__namedParameters.writable	WritableStream<R>
options?	any

Returns

ReadableStream<T>

Implementation of

globalThis.ReadableStream.pipeThrough

Defined in

polyfills/worker/ReadableStream/mod.ts:120

pipeTo

pipeTo

(destination, options?): `Promise<void>`

Parameters

Name	Type
destination	WritableStream<any>
options?	any

Returns

Promise<void>

Implementation of

globalThis.ReadableStream.pipeTo

Defined in

polyfills/worker/ReadableStream/mod.ts:134

tee

tee

(): [`ReadableStream<any>`, `ReadableStream<any>`]

Returns

[ReadableStream<any>, ReadableStream<any>]

Implementation of

globalThis.ReadableStream.tee

Defined in

polyfills/worker/ReadableStream/mod.ts:138

values

values

(options?): `AsyncIterableIterator<any>`

Parameters

Name	Type
options?	any

Returns

AsyncIterableIterator<any>

Defined in

polyfills/worker/ReadableStream/mod.ts:142