Interface: SyncPollOptions

@sapphire/utilities.SyncPollOptions

The options for the pollSync function

Hierarchy

• Omit<PollOptions, "signal">

  ↳ SyncPollOptions

Properties

maximumRetries

• Optional maximumRetries: null | number

The amount of attempts to try, if any.

Default

Infinite

Inherited from

Omit.maximumRetries

Defined in

lib/poll.ts:15

---

timeout

• Optional timeout: null | number

The amount of milliseconds before throwing an AbortError.

Default

Infinite

Defined in

lib/pollSync.ts:10

---

verbose

• Optional verbose: boolean

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

Default

false

Inherited from

Omit.verbose

Defined in

lib/poll.ts:27

---

waitBetweenRetries

• Optional waitBetweenRetries: null | number

The amount of time to wait between each poll.

Default

0

Inherited from

Omit.waitBetweenRetries

Defined in

lib/poll.ts:21