Interface PollingSourceOptions

The options of PollingSource.

interface PollingSourceOptions {
    clock?: Clock;
    heartbeat?: () => {} | undefined;
    limit?: number;
    logger?: Logger;
    random?: () => number;
    settings?: SdkSettings | Partial<SdkSettings>;
}

Properties

clock?: Clock

The time source (default the client's).

heartbeat?: () => {} | undefined

Returns the agent heartbeat to send, or undefined for none.

limit?: number

The page size asked for (the server caps it).

logger?: Logger

The logger (default the client's).

random?: () => number

The jitter source in [0, 1) of the retry wait (default from node:crypto).

settings?: SdkSettings | Partial<SdkSettings>

The SDK settings (sdk.poll_interval, the reconnect backoff); default the client's.