Skip to main content

@slack/web-api / RetryOptions

Interface: RetryOptions

Defined in: packages/web-api/src/retry-policies.ts:6

Options to create retry policies. Extends from https://github.com/tim-kos/node-retry.

Extends​

  • WrapOptions

Properties​

factor?​

optional factor?: number;

Defined in: packages/web-api/node_modules/@types/retry/index.d.ts:119

The exponential factor to use.

Default​

2

Inherited from​

WrapOptions.factor

forever?​

optional forever?: boolean;

Defined in: packages/web-api/node_modules/@types/retry/index.d.ts:82

Whether to retry forever.

Default​

false

Inherited from​

WrapOptions.forever

maxRetryTime?​

optional maxRetryTime?: number;

Defined in: packages/web-api/node_modules/@types/retry/index.d.ts:92

The maximum time (in milliseconds) that the retried operation is allowed to run.

Default​

Infinity

Inherited from​

WrapOptions.maxRetryTime

maxTimeout?​

optional maxTimeout?: number;

Defined in: packages/web-api/node_modules/@types/retry/index.d.ts:129

The maximum number of milliseconds between two retries.

Default​

Infinity

Inherited from​

WrapOptions.maxTimeout

minTimeout?​

optional minTimeout?: number;

Defined in: packages/web-api/node_modules/@types/retry/index.d.ts:124

The number of milliseconds before starting the first retry.

Default​

1000

Inherited from​

WrapOptions.minTimeout

randomize?​

optional randomize?: boolean;

Defined in: packages/web-api/node_modules/@types/retry/index.d.ts:134

Randomizes the timeouts by multiplying a factor between 1-2.

Default​

false

Inherited from​

WrapOptions.randomize

retries?​

optional retries?: number;

Defined in: packages/web-api/node_modules/@types/retry/index.d.ts:103

The maximum amount of times to retry the operation.

Default​

10

Inherited from​

WrapOptions.retries

unref?​

optional unref?: boolean;

Defined in: packages/web-api/node_modules/@types/retry/index.d.ts:87

Whether to unref the setTimeout's.

Default​

false

Inherited from​

WrapOptions.unref