bothy-sdk
    Preparing search index...

    Interface GatewayOptions

    The options of Gateway.

    interface GatewayOptions {
        agentId: string;
        clock?: Clock;
        consumer: string;
        heartbeat?: () => {} | undefined;
        logger?: Logger;
        nonceSink?: (nonce: string | undefined) => void;
        random?: () => number;
        settings?: Partial<SdkSettings>;
        userAgent?: string;
        WebSocket?: GatewaySocketConstructor;
    }
    Index

    Properties

    agentId clock? consumer heartbeat? logger? nonceSink? random? settings? userAgent? WebSocket?

    Properties

    agentId: string

    The agent's principal ID; ready for another principal stops the gateway.

    clock?: Clock

    The time source of heartbeats and waits (default systemClock).

    consumer: string

    The consumer name (^[a-z0-9][a-z0-9_-]*$).

    heartbeat?: () => {} | undefined

    Returns the agent heartbeat for the member agent (or undefined for none).

    logger?: Logger

    The logger (default defaultLogger).

    nonceSink?: (nonce: string | undefined) => void

    Receives each DPoP nonce of hello (the REST client may share it).

    random?: () => number

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

    settings?: Partial<SdkSettings>

    Overrides of the SDK settings (reconnect backoff, frame size, connect timeout).

    userAgent?: string

    The User-Agent of the upgrade request; absent leaves the WebSocket default.

    WebSocket?: GatewaySocketConstructor

    The WebSocket constructor (default the global WebSocket).

    Settings

    Member Visibility

    On This Page

    Properties