TimeoutOptions
Defined in: src/timeout.ts:9
Properties
Section titled “Properties”cooperative?
Section titled “cooperative?”
optionalcooperative?:boolean
Defined in: src/timeout.ts:19
false (default): give up as soon as the time is up, even if the callback ignores the signal.
true: abort the signal, then wait for the callback to finish (Polly v8 behaviour), so no work outlives the timeout.
keepLateResult?
Section titled “keepLateResult?”
optionalkeepLateResult?:boolean
Defined in: src/timeout.ts:21
With cooperative: if the callback still succeeds after the deadline, return its result instead of the timeout error.
optionalname?:string
Defined in: src/timeout.ts:10
onTimeout?
Section titled “onTimeout?”
optionalonTimeout?: (args) =>MaybePromise<void>
Defined in: src/timeout.ts:14
Parameters
Section titled “Parameters”Returns
Section titled “Returns”MaybePromise<void>
timeout?
Section titled “timeout?”
optionaltimeout?:Duration
Defined in: src/timeout.ts:12
Default 30 s. Infinity disables the timeout.
timeoutGenerator?
Section titled “timeoutGenerator?”
optionaltimeoutGenerator?: (args) =>MaybePromise<Duration>
Defined in: src/timeout.ts:13