Skip to main content

Interface: PollOptions

The options for the poll function

Properties

maximumRetries?

optional maximumRetries: null | number

The amount of attempts to try, if any.

Default

Infinite

Source

lib/poll.ts:15


signal?

optional signal: AbortSignal

An optional AbortSignal to abort the polling.

Source

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

Source

lib/poll.ts:27


waitBetweenRetries?

optional waitBetweenRetries: null | number

The amount of time to wait between each poll.

Default

0

Source

lib/poll.ts:21