Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RetryConfig<T>

Package version

Describes the parameters that need to be configured for the retry operation.

Type parameters

  • T

Hierarchy

  • RetryConfig

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike
property

{AbortSignalLike} [abortSignal] The AbortSignal associated with the operation being retried on. If this signal is fired during the wait time between retries, then the retry() method will ensure that the wait is abandoned and the retry process gets cancelled. If this signal is fired when the operation is in progress, then the operation is expected to react to it.

Optional connectionHost

connectionHost: undefined | string
property

{string} connectionHost The host ".servicebus.windows.net". Used to check network connectivity.

connectionId

connectionId: string
property

{string} connectionId The connection identifier. Used in logging information. Extremely useful when multiple connections are logged in the same file.

operation

operation: () => Promise<T>
property

{Promise} operation The operation that needs to be retried.

Type declaration

    • (): Promise<T>
    • Returns Promise<T>

operationType

operationType: RetryOperationType
property

{RetryOperationType} operationType The name/type of operation to be performed. Extremely useful in providing better debug logs.

Optional retryOptions

retryOptions: RetryOptions
property

{RetryOptions} retryOptions The retry related options associated with given operation execution.

Generated using TypeDoc