UNPKG

1.16 kBTypeScriptView Raw
1import { AbortController } from "./abort";
2/**
3 * @public
4 */
5export interface WaiterConfiguration<Client> {
6 /**
7 * Required service client
8 */
9 client: Client;
10 /**
11 * The amount of time in seconds a user is willing to wait for a waiter to complete.
12 */
13 maxWaitTime: number;
14 /**
15 * @deprecated Use abortSignal
16 * Abort controller. Used for ending the waiter early.
17 */
18 abortController?: AbortController;
19 /**
20 * Abort Signal. Used for ending the waiter early.
21 */
22 abortSignal?: AbortController["signal"];
23 /**
24 * The minimum amount of time to delay between retries in seconds. This is the
25 * floor of the exponential backoff. This value defaults to service default
26 * if not specified. This value MUST be less than or equal to maxDelay and greater than 0.
27 */
28 minDelay?: number;
29 /**
30 * The maximum amount of time to delay between retries in seconds. This is the
31 * ceiling of the exponential backoff. This value defaults to service default
32 * if not specified. If specified, this value MUST be greater than or equal to 1.
33 */
34 maxDelay?: number;
35}