Skip to main content

Interface: PollOptions

@sapphire/utilities.PollOptions

The options for the poll function

Properties

maximumRetries

Optional maximumRetries: null | number

The amount of attempts to try, if any.

Default

Infinite

Defined in

lib/poll.ts:15


signal

Optional signal: AbortSignal

An optional AbortSignal to abort the polling.

Defined in

lib/poll.ts:9


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

Defined in

lib/poll.ts:27


waitBetweenRetries

Optional waitBetweenRetries: null | number

The amount of time to wait between each poll.

Default

0

Defined in

lib/poll.ts:21