Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for piping a stream.

Hierarchy

  • StreamPipeOptions

Index

Properties

Optional preventAbort

preventAbort?: boolean

If set to true, ReadableStream.pipeTo will not abort the writable stream if the readable stream errors.

Optional preventCancel

preventCancel?: boolean

If set to true, ReadableStream.pipeTo will not cancel the readable stream if the writable stream closes or errors.

Optional preventClose

preventClose?: boolean

If set to true, ReadableStream.pipeTo will not close the writable stream if the readable stream closes.

Optional signal

signal?: AbortSignal

Can be set to an AbortSignal to allow aborting an ongoing pipe operation via the corresponding AbortController. In this case, the source readable stream will be canceled, and the destination writable stream aborted, unless the respective options preventCancel or preventAbort are set.

Generated using TypeDoc