Module common/lib/waiter

Classes

Interfaces

Type aliases

WaiterConfiguration

Functions

Object literals

DefaultWaiterConfigurationDetails

Type aliases

WaiterConfiguration

WaiterConfiguration: Partial<WaiterConfigurationDetails>

Functions

delay

delay(second: number): Promise<unknown>

- Defined in lib/common/lib/waiter.ts:93
Parameters
- second: number
Returns Promise<unknown>

genericTerminalConditionWaiter

genericTerminalConditionWaiter<Response>(config: WaiterConfiguration | undefined, serviceCall: function, terminationPredicate: function, allow404?: boolean): Promise<Response | null>

- Defined in lib/common/lib/waiter.ts:97
Type parameters
- Response
Parameters
- config: WaiterConfiguration | undefined
- serviceCall: function
  - - (): Promise<Response>
    - Returns Promise<Response>
- terminationPredicate: function
  - - (response: Response): boolean
    - Parameters
      - response: Response
      Returns boolean
- Default value allow404: boolean = false
Returns Promise<Response | null>

genericWaiter

genericWaiter<Response>(config: WaiterConfiguration | undefined, serviceCall: function, terminationPredicate: function): Promise<Response>

- Defined in lib/common/lib/waiter.ts:113
Type parameters
- Response
Parameters
- config: WaiterConfiguration | undefined
- serviceCall: function
  - - (): Promise<Response>
    - Returns Promise<Response>
- terminationPredicate: function
  - - (response: Response): boolean
    - Parameters
      - response: Response
      Returns boolean
Returns Promise<Response>

Object literals

Const DefaultWaiterConfigurationDetails

DefaultWaiterConfigurationDetails: object

delayStrategy

delayStrategy: ExponentialBackoffDelayStrategy = new ExponentialBackoffDelayStrategy(30)

terminationStrategy

terminationStrategy: MaxTimeTerminationStrategy = new MaxTimeTerminationStrategy(1200)