Interface WithTimeoutOptions

interface WithTimeoutOptions {
    abortController?: AbortController;
    onError?: (error: Error, didTimeout: boolean) => void;
    onTimeout?: (error: TimeoutError) => void;
    throws?: boolean;
    timeout: number;
}

Index

Properties

abortController? onError? onTimeout? throws? timeout

Properties

`Optional`abortController

abortController?: AbortController

Abort controller to cancel the operation

`Optional`onError

onError?: (error: Error, didTimeout: boolean) => void

Capture errors

`Optional`onTimeout

onTimeout?: (error: TimeoutError) => void

On timeout callback

`Optional`throws

throws?: boolean

Rethrow errors

timeout

timeout: number

Timeout in milliseconds after which the function will be rejected