Skip to main content

Interface: SyncPollOptions

The options for the pollSync function

Extends

Properties

maximumRetries?

optional maximumRetries: null | number

The amount of attempts to try, if any.

Default

Infinite

Inherited from

Omit.maximumRetries

Source

lib/poll.ts:15


timeout?

optional timeout: null | number

The amount of milliseconds before throwing an AbortError.

Default

Infinite

Source

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

Source

lib/poll.ts:27


waitBetweenRetries?

optional waitBetweenRetries: null | number

The amount of time to wait between each poll.

Default

0

Inherited from

Omit.waitBetweenRetries

Source

lib/poll.ts:21