Skip to main content

@terascope/core-utils / promises / PRetryConfig

Interface: PRetryConfig

Defined in: core-utils/src/promises.ts:67

Properties

PropertyTypeDescriptionDefined in
backoffnumberThe backoff multiplier Default 2core-utils/src/promises.ts:95
delaynumberThe initial time to delay before retrying the function Default 500core-utils/src/promises.ts:81
endWithFatalbooleanIf set to true, this will set fail with fatalError to truecore-utils/src/promises.ts:100
logError(...args) => voidLog function for logging any errors that occurredcore-utils/src/promises.ts:110
matches?(string | RegExp)[]Generally all errors will be treated as retryable, but if you want to limit which errors are retryable you can provide an array of strings or regex patterns to match against the error message and only those that match are considered retryablecore-utils/src/promises.ts:118
maxDelaynumberThe maximum time to delay when retrying in milliseconds Default 60000core-utils/src/promises.ts:88
reason?stringYou may set a custom error message if the pRetry failscore-utils/src/promises.ts:105
retriesnumberThe number of retries to attempt before failing. This does not include the initial attempt Default 3core-utils/src/promises.ts:74