Interface WritableStreamDefaultWriter<W>

This Streams API interface is the object returned by WritableStream.getWriter() and once created locks the < writer to the WritableStream ensuring that no other streams can write to the underlying sink.

interface WritableStreamDefaultWriter<W> {
    closed: Promise<undefined>;
    desiredSize: null | number;
    ready: Promise<undefined>;
    abort(reason?): Promise<void>;
    close(): Promise<void>;
    releaseLock(): void;
    write(chunk?): Promise<void>;
}

Type Parameters

  • W = any

Properties

closed desiredSize ready

Methods

abort close releaseLock write

Properties

Readonly closed

closed: Promise<undefined>

Readonly desiredSize

desiredSize: null | number

Readonly ready

ready: Promise<undefined>

Methods

abort

  • abort(reason?): Promise<void>

  • Parameters

    • Optional reason: any

    Returns Promise<void>

close

  • close(): Promise<void>

  • Returns Promise<void>

releaseLock

  • releaseLock(): void

  • Returns void

write

  • write(chunk?): Promise<void>

  • Parameters

    • Optional chunk: W

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc