@convergence/convergence/typings/IConvergenceOptions.d.ts

Convergence JavaScript Client

import { WebSocketFactory } from "./connection/WebSocketFactory";
import { IWebSocketClass } from "./connection/IWebSocketClass";
import { IFallbackAuthChallenge } from "./IFallbackAuthChallenge";
import { IStorageAdapter } from "./storage";
export interface IConvergenceOptions {
    connection?: {
        timeout?: number;
        connectionRequestTimeout?: number;
    };
    protocol?: {
        defaultRequestTimeout: number;
        heartbeat?: {
            enabled: boolean;
            pingInterval?: number;
            pongTimeout?: number;
        };
    };
    reconnect?: {
        autoReconnect?: boolean;
        autoReconnectOnInitial?: boolean;
        reconnectIntervals?: number[];
        fallbackAuth?: (authChallenge: IFallbackAuthChallenge) => void;
    };
    offline?: {
        storage: IStorageAdapter;
        modelSnapshotInterval?: number;
    };
    webSocket?: {
        factory?: WebSocketFactory;
        class?: IWebSocketClass;
    };
    models?: {
        data?: {
            undefinedObjectValues?: "error" | "omit";
            undefinedArrayValues?: "error" | "null";
        };
    };
}