Options
All
  • Public
  • Public/Protected
  • All
Menu

Module common/lib/waiter

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

WaiterConfiguration

WaiterConfiguration: Partial<WaiterConfigurationDetails>

Functions

delay

  • delay(second: number): Promise<unknown>

genericTerminalConditionWaiter

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

  • 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>

  • 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)