RTCForge API Reference v1.1.1
    Preparing search index...

    Interface RTCForgeClientOptions

    Configuration for constructing an RTCForgeClient.

    interface RTCForgeClientOptions {
        connectTimeoutMs?: number;
        joinTimeoutMs?: number;
        logger?: Logger;
        maxQueueSize?: number;
        maxReconnectAttempts?: number;
        maxReconnectDelay?: number;
        nonRetryableCloseCodes?: number[];
        peerId?: string;
        reconnect?: boolean;
        serverUrl: string;
        token?: string;
        tokenRefresh?: () => Promise<string>;
        transportFactory?: TransportFactory;
    }
    Index

    Properties

    connectTimeoutMs? joinTimeoutMs? logger? maxQueueSize? maxReconnectAttempts? maxReconnectDelay? nonRetryableCloseCodes? peerId? reconnect? serverUrl token? tokenRefresh? transportFactory?

    Properties

    connectTimeoutMs?: number

    Timeout (ms) for a single connect attempt.

    joinTimeoutMs?: number

    Timeout (ms) awaiting the room-joined handshake reply.

    30000

    logger?: Logger

    Logger for client and transport diagnostics.

    noopLogger

    maxQueueSize?: number

    Maximum number of messages queued while offline.

    100

    maxReconnectAttempts?: number

    Maximum reconnect attempts before failing; unlimited when omitted.

    maxReconnectDelay?: number

    Upper bound (ms) on the reconnect backoff delay.

    32000

    nonRetryableCloseCodes?: number[]

    Close codes that must NOT trigger a reconnect (retrying is futile, e.g. a rejected/expired token → 1008). Forwarded to the transport; on such a close the client emits ClientEvent.Terminated.

    [1008]

    peerId?: string

    Explicit peer identifier, appended as peerId when no token is set.

    reconnect?: boolean

    Whether the transport reconnects automatically after a drop.

    true

    serverUrl: string

    Base signaling server URL (ws:// or wss://); roomId and auth params are appended per join.

    token?: string

    Static auth token appended as the token query parameter. Takes precedence over peerId.

    tokenRefresh?: () => Promise<string>

    Async callback that yields a fresh token before each reconnect; forwarded to the transport.

    transportFactory?: TransportFactory

    Overrides the default WebSocketTransport factory.

    Settings

    Member Visibility

    On This Page

    Properties