RetryOptions.md

@slack/web-api / RetryOptions

Interface: RetryOptions

Defined in: src/retry-policies.ts:6

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

Extends

• OperationOptions

Properties

factor?

optional factor: number;

Defined in: node_modules/@types/retry/index.d.ts:125

The exponential factor to use.

Default

2

Inherited from

OperationOptions.factor

---

forever?

optional forever: boolean;

Defined in: node_modules/@types/retry/index.d.ts:88

Whether to retry forever.

Default

false

Inherited from

OperationOptions.forever

---

maxRetryTime?

optional maxRetryTime: number;

Defined in: node_modules/@types/retry/index.d.ts:98

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

Default

Infinity

Inherited from

OperationOptions.maxRetryTime

---

maxTimeout?

optional maxTimeout: number;

Defined in: node_modules/@types/retry/index.d.ts:135

The maximum number of milliseconds between two retries.

Default

Infinity

Inherited from

OperationOptions.maxTimeout

---

minTimeout?

optional minTimeout: number;

Defined in: node_modules/@types/retry/index.d.ts:130

The number of milliseconds before starting the first retry.

Default

1000

Inherited from

OperationOptions.minTimeout

---

randomize?

optional randomize: boolean;

Defined in: node_modules/@types/retry/index.d.ts:140

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

Default

false

Inherited from

OperationOptions.randomize

---

retries?

optional retries: number;

Defined in: node_modules/@types/retry/index.d.ts:109

The maximum amount of times to retry the operation.

Default

10

Inherited from

OperationOptions.retries

---

unref?

optional unref: boolean;

Defined in: node_modules/@types/retry/index.d.ts:93

Whether to unref the setTimeout's.

Default

false

Inherited from

OperationOptions.unref