Skip to content

@ralphschuler.logger.Logger.<internal>.ReadableStream

github-actions edited this page Nov 26, 2023 · 1 revision

Interface: ReadableStream<R>

Logger.<internal>.ReadableStream

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

Type parameters

Name Type
R any

Table of contents

Properties

Methods

Properties

locked

Readonly locked: boolean

Defined in

node_modules/@types/node/stream/web.d.ts:147

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<R>

Returns

AsyncIterableIterator<R>

Defined in

node_modules/@types/node/stream/web.d.ts:155


cancel

cancel(reason?): Promise<void>

Parameters

Name Type
reason? any

Returns

Promise<void>

Defined in

node_modules/@types/node/stream/web.d.ts:148


getReader

getReader(): ReadableStreamDefaultReader<R>

Returns

ReadableStreamDefaultReader<R>

Defined in

node_modules/@types/node/stream/web.d.ts:149

getReader(options): ReadableStreamBYOBReader

Parameters

Name Type
options Object
options.mode "byob"

Returns

ReadableStreamBYOBReader

Defined in

node_modules/@types/node/stream/web.d.ts:150


pipeThrough

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

Type parameters

Name
T

Parameters

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

Returns

ReadableStream<T>

Defined in

node_modules/@types/node/stream/web.d.ts:151


pipeTo

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

Parameters

Name Type
destination WritableStream<R>
options? StreamPipeOptions

Returns

Promise<void>

Defined in

node_modules/@types/node/stream/web.d.ts:152


tee

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

Returns

[ReadableStream<R>, ReadableStream<R>]

Defined in

node_modules/@types/node/stream/web.d.ts:153


values

values(options?): AsyncIterableIterator<R>

Parameters

Name Type
options? Object
options.preventCancel? boolean

Returns

AsyncIterableIterator<R>

Defined in

node_modules/@types/node/stream/web.d.ts:154

Typescript Libraries

Modules

Namespaces

Clone this wiki locally