Class PollOptions

Options for the high-level waitFor* polling helpers.

Index

Constructors

Properties

intervalMs timeoutMs

Constructors

constructor

new PollOptions(intervalMs?: number, timeoutMs?: number): PollOptions
Parameters
- intervalMs: number = 2000
  How long to sleep between status polls, in milliseconds. Default: 2000 ms.
- timeoutMs: number = 300_000
  Maximum total time to wait before throwing IdkollenError with code "poll_timeout", in milliseconds. Default: 300 000 ms.
Returns PollOptions
- Defined in src/client.ts:26

Properties

`Readonly`intervalMs

intervalMs: number = 2000

How long to sleep between status polls, in milliseconds. Default: 2000 ms.

`Readonly`timeoutMs

timeoutMs: number = 300_000

Maximum total time to wait before throwing IdkollenError with code "poll_timeout", in milliseconds. Default: 300 000 ms.