Interface HeartbeatSenderOptions

The options of HeartbeatSender.

interface HeartbeatSenderOptions {
    build: () => {} | undefined;
    clock?: Clock;
    logger?: Logger;
    send: HeartbeatSend;
    settings?: Partial<SdkSettings>;
}

Index

Properties

build clock? logger? send settings?

Properties

`Readonly`build

build: () => {} | undefined

Returns the heartbeat to send now (for example from buildHeartbeat), or undefined to skip this interval.

`Optional` `Readonly`clock

clock?: Clock

The time source of the waits (default systemClock).

`Optional` `Readonly`logger

logger?: Logger

The logger (default defaultLogger).

`Readonly`send

send: HeartbeatSend

Sends it: restHeartbeatSend or a gateway callback.

`Optional` `Readonly`settings

settings?: Partial<SdkSettings>

Settings; pollIntervalMs (sdk.poll_interval) is the wait before the first answer.