Interface FinishedOptions

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

Hierarchy (view full)

Properties

signal? error? readable? writable? cleanup?

Properties

Optionalsignal

signal?: AbortSignal

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

Optionalerror

error?: boolean

Optionalreadable

readable?: boolean

Optionalwritable

writable?: boolean

Optionalcleanup

cleanup?: boolean

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

Default

false

Settings

Member Visibility

On This Page

Properties