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

Private retries

retries: number = RetrierOptions.RETRIES_DEFAULT

Private Optional retryIntervalMs

retryIntervalMs: undefined | number

Private Optional timeoutMsValue

timeoutMsValue: undefined | number

Static RETRIES_DEFAULT

RETRIES_DEFAULT: 10 = 10

The default value for retries

Static RETRY_INTERVAL_MS_DEFAULT

RETRY_INTERVAL_MS_DEFAULT: 10 = 10

The default interval between retries

Static TIMEOUT_MS_DEFAULT

TIMEOUT_MS_DEFAULT: 1000 = 1000

The default timeout in millisecs

Accessors

Retries

  • get Retries(): number
  • set Retries(v: number): 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

Generated using TypeDoc