Interface: ReadableStream<R>

Defined in: types/desktop-engine.d.ts:4531

A source of chunks; async iterable (for await (const chunk of stream))

Type Parameters

Type Parameter	Default type
R	any

Properties

locked

readonly locked: boolean;

Defined in: types/desktop-engine.d.ts:4532

Methods

[asyncIterator]()

asyncIterator: AsyncIterableIterator<R>;

Defined in: types/desktop-engine.d.ts:4540

Parameters

Parameter	Type
options?	{ preventCancel?: boolean; }
options.preventCancel?	boolean

Returns

AsyncIterableIterator<R>

---

cancel()

cancel(reason?): Promise<void>;

Defined in: types/desktop-engine.d.ts:4533

Parameters

Parameter	Type
reason?	any

Returns

Promise<void>

---

getReader()

Call Signature

getReader(options): ReadableStreamBYOBReader;

Defined in: types/desktop-engine.d.ts:4534

Parameters

Parameter	Type
options	{ mode: "byob"; }
options.mode	"byob"

Returns

ReadableStreamBYOBReader

Call Signature

getReader(options?): ReadableStreamDefaultReader<R>;

Defined in: types/desktop-engine.d.ts:4535

Parameters

Parameter	Type
options?	{ mode?: undefined; }
options.mode?	undefined

Returns

ReadableStreamDefaultReader<R>

---

pipeThrough()

pipeThrough<T>(transform, options?): ReadableStream<T>;

Defined in: types/desktop-engine.d.ts:4536

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
transform	ReadableWritablePair<T, R>
options?	StreamPipeOptions

Returns

ReadableStream<T>

---

pipeTo()

pipeTo(destination, options?): Promise<void>;

Defined in: types/desktop-engine.d.ts:4537

Parameters

Parameter	Type
destination	WritableStream<R>
options?	StreamPipeOptions

Returns

Promise<void>

---

tee()

tee(): [ReadableStream<R>, ReadableStream<R>];

Defined in: types/desktop-engine.d.ts:4538

Returns

[ReadableStream<R>, ReadableStream<R>]

---

values()

values(options?): AsyncIterableIterator<R>;

Defined in: types/desktop-engine.d.ts:4539

Parameters

Parameter	Type
options?	{ preventCancel?: boolean; }
options.preventCancel?	boolean

Returns

AsyncIterableIterator<R>