Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WaiterConfiguration<Client>

public

Type parameters

  • Client

Hierarchy

  • WaiterConfiguration

Index

Properties

Properties

Optional abortController

abortController: AbortController
deprecated

Use abortSignal Abort controller. Used for ending the waiter early.

Optional abortSignal

abortSignal: AbortController["signal"]

Abort Signal. Used for ending the waiter early.

client

client: Client

Required service client

Optional maxDelay

maxDelay: undefined | number

The maximum amount of time to delay between retries in seconds. This is the ceiling of the exponential backoff. This value defaults to service default if not specified. If specified, this value MUST be greater than or equal to 1.

maxWaitTime

maxWaitTime: number

The amount of time in seconds a user is willing to wait for a waiter to complete.

Optional minDelay

minDelay: undefined | number

The minimum amount of time to delay between retries in seconds. This is the floor of the exponential backoff. This value defaults to service default if not specified. This value MUST be less than or equal to maxDelay and greater than 0.