PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / StreamWriter

Interface: StreamWriter<Chunk, Final> ​

Defined in: core/types/stream/StreamWriter.ts:1

Type Parameters ​

Chunk ​

Chunk = unknown

Final ​

Final = unknown

Properties ​

cancelled ​

readonly cancelled: boolean

Defined in: core/types/stream/StreamWriter.ts:2

Methods ​

close() ​

close(final?): Promise<void>

Defined in: core/types/stream/StreamWriter.ts:4

Parameters ​

final? ​

Final

Returns ​

Promise<void>

fail() ​

fail(error): Promise<void>

Defined in: core/types/stream/StreamWriter.ts:5

Parameters ​

error ​

unknown

Returns ​

Promise<void>

onCancel() ​

onCancel(cb): void

Defined in: core/types/stream/StreamWriter.ts:6

Parameters ​

cb ​

(reason?) => void

Returns ​

void

write() ​

write(chunk): Promise<void>

Defined in: core/types/stream/StreamWriter.ts:3

Parameters ​

chunk ​

Chunk

Returns ​

Promise<void>