Interface: SyncPollOptions

Defined in: pollSync.ts:5

The options for the pollSync function

Extends

• Omit<PollOptions, "signal">

Properties

maximumRetries?

optional maximumRetries: null | number

Defined in: poll.ts:15

The amount of attempts to try, if any.

Default

Infinite

Inherited from

PollOptions.maximumRetries

---

timeout?

optional timeout: null | number

Defined in: pollSync.ts:10

The amount of milliseconds before throwing an AbortError.

Default

Infinite

---

verbose?

optional verbose: boolean

Defined in: poll.ts:27

Whether to log to the console on each polling interval, allowing the tracing of the amount of required attempts.

Default

false

Inherited from

PollOptions.verbose

---

waitBetweenRetries?

optional waitBetweenRetries: null | number

Defined in: poll.ts:21

The amount of time to wait between each poll.

Default

0

Inherited from

PollOptions.waitBetweenRetries