Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RetrierOptions

Options class for Retrier

Hierarchy

  • RetrierOptions

Index

Properties

Optional OnFail

OnFail: undefined | function

Optional callback, triggered on fail (timeout or too many retries)

Optional OnSuccess

OnSuccess: undefined | function

Optional callback, triggered on success

Optional OnTry

OnTry: undefined | function

Optional callback, triggered right before each try

Static RETRIES_DEFAULT

RETRIES_DEFAULT: 10 = 10

Static RETRY_INTERVAL_MS_DEFAULT

RETRY_INTERVAL_MS_DEFAULT: 10 = 10

Static TIMEOUT_MS_DEFAULT

TIMEOUT_MS_DEFAULT: 1000 = 1000

Accessors

Retries

  • get Retries(): number
  • set Retries(v: number): void
  • How many times should retry the operation

    Returns number

  • How many times should retry the operation

    Parameters

    • v: number

    Returns void

RetryIntervalMs

  • get RetryIntervalMs(): number
  • set RetryIntervalMs(v: number): void
  • The interval between tries in milliseconds

    Returns number

  • The interval between tries in milliseconds

    Parameters

    • v: number

    Returns void

TimeoutMs

  • get TimeoutMs(): number
  • set TimeoutMs(v: number): void
  • The Timeout interval in milliseconds

    Returns number

  • The Timeout interval in milliseconds

    Parameters

    • v: number

    Returns void

Generated using TypeDoc