Class PromiseReadable<TReadable>

Type Parameters

TReadable extends ReadableStream

Hierarchy

PromiseReadable
- PromiseDuplex

Implements

AsyncIterable<Buffer | string>

Index

Constructors

Properties

_errored? _isPromiseReadable errorHandler stream

Methods

[asyncIterator] destroy iterate once read readAll setEncoding [hasInstance]

Constructors

constructor

new PromiseReadable<TReadable>(stream: TReadable): PromiseReadable<TReadable>
Type Parameters
- TReadable extends ReadableStream<TReadable>
Parameters
- stream: TReadable
Returns PromiseReadable<TReadable>
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:12

Properties

`Optional` _errored

_errored?: Error

`Readonly` _isPromiseReadable

_isPromiseReadable: boolean

`Private` `Readonly` errorHandler

errorHandler: any

`Readonly` stream

stream: TReadable

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<string | Buffer>
Returns AsyncIterableIterator<string | Buffer>
Implementation of AsyncIterable.[asyncIterator]
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:20

destroy

destroy(): void
Returns void
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:21

iterate

iterate(size?: number): AsyncIterableIterator<string | Buffer>
Parameters
- Optional size: number
Returns AsyncIterableIterator<string | Buffer>
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:19

once

once(event: "close" | "error" | "end"): Promise<void>
Parameters
- event: "close" | "error" | "end"
Returns Promise<void>
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:17
once(event: "open"): Promise<number>
Parameters
- event: "open"
Returns Promise<number>
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:18

read

read(size?: number): Promise<undefined | string | Buffer>
Parameters
- Optional size: number
Returns Promise<undefined | string | Buffer>
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:14

readAll

readAll(): Promise<undefined | string | Buffer>
Returns Promise<undefined | string | Buffer>
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:15

setEncoding

setEncoding(encoding: BufferEncoding): PromiseReadable<TReadable>
Parameters
- encoding: BufferEncoding
Returns PromiseReadable<TReadable>
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:16

`Static` [hasInstance]

[hasInstance](instance: any): boolean
Parameters
- instance: any
Returns boolean
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:13

Generated using TypeDoc