Class PromiseDuplex<TDuplex>

Type Parameters

TDuplex extends DuplexStream

Hierarchy

PromiseReadable<TDuplex>
- PromiseDuplex
  - PromiseSocket

Implements

AsyncIterable<Buffer | string>

Index

Constructors

Properties

_errored? _isPromiseReadable isPromiseReadable isPromiseWritable readable stream writable

Methods

[asyncIterator] destroy end iterate once read readAll setEncoding write writeAll [hasInstance]

Constructors

constructor

new PromiseDuplex<TDuplex>(stream: TDuplex): PromiseDuplex<TDuplex>
Type Parameters
- TDuplex extends DuplexStream<TDuplex>
Parameters
- stream: TDuplex
Returns PromiseDuplex<TDuplex>
Overrides PromiseReadable.constructor
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:15

Properties

`Optional` _errored

_errored?: Error

`Readonly` _isPromiseReadable

_isPromiseReadable: boolean

`Readonly` isPromiseReadable

isPromiseReadable: boolean

`Readonly` isPromiseWritable

isPromiseWritable: boolean

`Readonly` readable

readable: PromiseReadable<TDuplex>

`Readonly` stream

stream: TDuplex

`Readonly` writable

writable: PromiseWritable<TDuplex>

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<string | Buffer>
Returns AsyncIterableIterator<string | Buffer>
Implementation of AsyncIterable.[asyncIterator]

Overrides PromiseReadable.[asyncIterator]
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:20

destroy

destroy(): void
Returns void
Overrides PromiseReadable.destroy
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:27

end

end(): Promise<void>
Returns Promise<void>
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:23

iterate

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

once

once(event: "close" | "error" | "end" | "finish"): Promise<void>
Parameters
- event: "close" | "error" | "end" | "finish"
Returns Promise<void>
Overrides PromiseReadable.once
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:24
once(event: "open"): Promise<number>
Parameters
- event: "open"
Returns Promise<number>
Overrides PromiseReadable.once
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:25
once(event: "pipe" | "unpipe"): Promise<ReadableStream>
Parameters
- event: "pipe" | "unpipe"
Returns Promise<ReadableStream>
Overrides PromiseReadable.once
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:26

read

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

readAll

readAll(): Promise<undefined | string | Buffer>
Returns Promise<undefined | string | Buffer>
Overrides PromiseReadable.readAll
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:17

setEncoding

setEncoding(encoding: BufferEncoding): PromiseDuplex<TDuplex>
Parameters
- encoding: BufferEncoding
Returns PromiseDuplex<TDuplex>
Overrides PromiseReadable.setEncoding
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:18

write

write(chunk: string | Buffer, encoding?: BufferEncoding): Promise<number>
Parameters
- chunk: string | Buffer
- Optional encoding: BufferEncoding
Returns Promise<number>
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:21

writeAll

writeAll(content: string | Buffer, chunkSize?: number): Promise<number>
Parameters
- content: string | Buffer
- Optional chunkSize: number
Returns Promise<number>
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:22

`Static` [hasInstance]

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

Generated using TypeDoc