Class PromiseWritable<TWritable>

Type Parameters

TWritable extends WritableStream

Hierarchy

PromiseWritable

Index

Constructors

Properties

_errored? _isPromiseWritable errorHandler stream

Methods

destroy end once write writeAll [hasInstance]

Constructors

constructor

new PromiseWritable<TWritable>(stream: TWritable): PromiseWritable<TWritable>
Type Parameters
- TWritable extends WritableStream<TWritable>
Parameters
- stream: TWritable
Returns PromiseWritable<TWritable>
- Defined in node_modules/promise-writable/lib/promise-writable.d.ts:14

Properties

`Optional` _errored

_errored?: Error

`Readonly` _isPromiseWritable

_isPromiseWritable: boolean

`Private` errorHandler

errorHandler: any

`Readonly` stream

stream: TWritable

Methods

destroy

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

end

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

once

once(event: "close" | "error" | "finish"): Promise<void>
Parameters
- event: "close" | "error" | "finish"
Returns Promise<void>
- Defined in node_modules/promise-writable/lib/promise-writable.d.ts:18
once(event: "open"): Promise<number>
Parameters
- event: "open"
Returns Promise<number>
- Defined in node_modules/promise-writable/lib/promise-writable.d.ts:19
once(event: "pipe" | "unpipe"): Promise<ReadableStream>
Parameters
- event: "pipe" | "unpipe"
Returns Promise<ReadableStream>
- Defined in node_modules/promise-writable/lib/promise-writable.d.ts:20

write

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

writeAll

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

`Static` [hasInstance]

[hasInstance](instance: PromiseWritable<WritableStream>): boolean
Parameters
- instance: PromiseWritable<WritableStream>
Returns boolean
- Defined in node_modules/promise-writable/lib/promise-writable.d.ts:15

Generated using TypeDoc