@salesforce/core
    Preparing search index...

    Type Alias Options

    Options for the polling client.

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

    Implemented by

    Index
    frequency poll retryLimit? timeout timeoutErrorName?
    frequency: Duration

    How frequent should the polling function be called.

    poll: () => Promise<StatusResult>

    Polling function.

    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.

    timeoutErrorName?: string

    Change the name of the timeout error.

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

    Settings
    Member Visibility

    On This Page
    Properties