Skip to main content

Interface: PollOptions

Defined in: poll.ts:5

The options for the poll function

Properties​

maximumRetries?​

optional maximumRetries: null | number

Defined in: poll.ts:15

The amount of attempts to try, if any.

Default​

Infinite

signal?​

optional signal: AbortSignal

Defined in: poll.ts:9

An optional AbortSignal to abort the polling.

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

waitBetweenRetries?​

optional waitBetweenRetries: null | number

Defined in: poll.ts:21

The amount of time to wait between each poll.

Default​

0