Type Alias Options

Type declaration

• frequency: Duration

  How frequent should the polling function be called.

• poll: (() => Promise<StatusResult>)

  Polling function.

  • • (): Promise<StatusResult>

    • Returns Promise<StatusResult>

• OptionalretryLimit?: number | "INFINITELY"

  Maximum number of retries. Use 'INFINITELY' for unlimited retries until timeout is reached. If not specified, defaults to 'INFINITELY'.

• timeout: Duration

  Hard timeout for polling.

• OptionaltimeoutErrorName?: string

  Change the name of the timeout error.

  if (err.name === 'MyChangedName) ...
  Copy