Interface FinishedOptions

interface FinishedOptions {
    cleanup?: boolean;
    error?: boolean;
    readable?: boolean;
    signal?: AbortSignal;
    writable?: boolean;
}

Hierarchy (View Summary, Expand)

Stream.FinishedOptions
- FinishedOptions

Index

Properties

`Optional`cleanup

cleanup?: boolean

If true, removes the listeners registered by this function before the promise is fulfilled.

Default

false

`Optional`error

error?: boolean

`Optional`readable

readable?: boolean

`Optional`signal

signal?: AbortSignal

When provided the corresponding AbortController can be used to cancel an asynchronous action.

`Optional`writable

writable?: boolean