Type alias Options

Options: {
    frequency: Duration;
    poll: (() => Promise<StatusResult>);
    retryLimit?: number | "INFINITELY";
    timeout: Duration;
    timeoutErrorName?: string;
}

Options for the polling client.

Type declaration

  • frequency: Duration

    How frequent should the polling function be called.

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

    Polling function.

  • Optional retryLimit?: 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.

  • Optional timeoutErrorName?: string

    Change the name of the timeout error.

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

Settings

Member Visibility

Theme