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 = any> {
    closed: Promise<undefined>;
    desiredSize: null | number;
    ready: Promise<undefined>;
    abort(reason?: any): Promise<void>;
    close(): Promise<void>;
    releaseLock(): void;
    write(chunk?: W): Promise<void>;
}

Type Parameters

  • W = any

Properties

closed desiredSize ready

Methods

abort close releaseLock write

Properties

Readonlyclosed

closed: Promise<undefined>

ReadonlydesiredSize

desiredSize: null | number

Readonlyready

ready: Promise<undefined>

Methods

abort

  • abort(reason?: any): Promise<void>

  • Parameters

    • Optionalreason: any

    Returns Promise<void>

close

  • close(): Promise<void>

  • Returns Promise<void>

releaseLock

  • releaseLock(): void

  • Returns void

write

  • write(chunk?: W): Promise<void>

  • Parameters

    • Optionalchunk: W

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods