daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
3.8 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Interface: ReadableStream<R>
internal.ReadableStream
This Streams API interface 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.
Type parameters
| Name | Type |
|---|---|
R |
any |
Properties
locked
• Readonly locked: boolean
Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18489
Methods
cancel
▸ cancel(reason?): Promise<void>
Parameters
| Name | Type |
|---|---|
reason? |
any |
Returns
Promise<void>
Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18491
getReader
▸ getReader(options): ReadableStreamBYOBReader
Parameters
| Name | Type |
|---|---|
options |
Object |
options.mode |
"byob" |
Returns
Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18493
▸ getReader(): ReadableStreamDefaultReader<R>
Returns
ReadableStreamDefaultReader<R>
Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18494
▸ getReader(options?): ReadableStreamReader<R>
Parameters
| Name | Type |
|---|---|
options? |
ReadableStreamGetReaderOptions |
Returns
Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18495
pipeThrough
▸ pipeThrough<T>(transform, options?): ReadableStream<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
transform |
ReadableWritablePair<T, R> |
options? |
StreamPipeOptions |
Returns
Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18497
pipeTo
▸ pipeTo(destination, options?): Promise<void>
Parameters
| Name | Type |
|---|---|
destination |
WritableStream<R> |
options? |
StreamPipeOptions |
Returns
Promise<void>
Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18499
tee
▸ tee(): [ReadableStream<R>, ReadableStream<R>]
Returns
[ReadableStream<R>, ReadableStream<R>]
Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18501