ReadableStream

admin/discounts.internal.ReadableStream

This Streams API interface represents a readable stream of byte data.

Type parameters

RobjectRequired

Properties

lockedbooleanRequired

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<R>

Returns

AsyncIterableIterator<R>

AsyncIterableIteratorAsyncIterableIterator<R>Required

---

cancel

cancel(reason?): Promise<void>

Parameters

reasonany

Returns

Promise<void>

PromisePromise<void>Required

---

getReader

getReader(): ReadableStreamDefaultReader<R>

Returns

ReadableStreamDefaultReader<R>

ReadableStreamDefaultReaderReadableStreamDefaultReader<R>Required

---

pipeThrough

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

TobjectRequired

Parameters

transformReadableWritablePair<T, R>Required

optionsStreamPipeOptions

Returns

ReadableStream<T>

ReadableStreamReadableStream<T>Required

---

pipeTo

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

Parameters

destinationWritableStream<R>Required

optionsStreamPipeOptions

Returns

Promise<void>

PromisePromise<void>Required

---

tee

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

Returns

[ReadableStream<R>, ReadableStream<R>]

[[`ReadableStream`](/references/js-client/admin_discounts/modules/admin_discounts.internal#readablestream)<`R`\>, [`ReadableStream`](/references/js-client/admin_discounts/modules/admin_discounts.internal#readablestream)<`R`\>][ReadableStream<R>, ReadableStream<R>]Required

---

values

values(options?): AsyncIterableIterator<R>

Parameters

optionsobject

options.preventCancelboolean

Returns

AsyncIterableIterator<R>

AsyncIterableIteratorAsyncIterableIterator<R>Required