Options
All
  • Public
  • Public/Protected
  • All
Menu

Allows control of a writable stream's state and internal queue.

Type parameters

  • W = any

Hierarchy

  • WritableStreamDefaultController

Index

Constructors

Properties

Methods

Constructors

Private constructor

Properties

Readonly abortReason

abortReason: any

The reason which was passed to WritableStream.abort(reason) when the stream was aborted.

Readonly signal

signal: AbortSignal

An AbortSignal that can be used to abort the pending write or close operation when the stream is aborted.

Methods

error

  • error(e?: any): void
  • Closes the controlled writable stream, making all future interactions with it fail with the given error e.

    This method is rarely used, since usually it suffices to return a rejected promise from one of the underlying sink's methods. However, it can be useful for suddenly shutting down a stream in response to an event outside the normal lifecycle of interactions with the underlying sink.

    Parameters

    • Optional e: any

    Returns void

Generated using TypeDoc