AIRI Server API - v0.10.2
    Preparing search index...

    Interface ClientOptions<C>

    interface ClientOptions<C = undefined> {
        url?: string;
        name: string;
        token?: string;
        websocketConstructor?: WebSocketLikeConstructor;
        connectTimeoutMs?: number;
        possibleEvents?: (keyof WebSocketEvents<C>)[];
        identity?: ModuleIdentity;
        dependencies?: ModuleDependency[];
        configSchema?: ModuleConfigSchema;
        heartbeat?: ClientHeartbeatOptions;
        autoConnect?: boolean;
        autoReconnect?: boolean;
        maxReconnectAttempts?: number;
        onError?: (error: unknown) => void;
        onClose?: () => void;
        onReady?: () => void;
        onStateChange?: (context: ClientStateChangeContext) => void;
        onAnyMessage?: (data: WebSocketEvent<C>) => void;
        onAnySend?: (data: WebSocketEvent<C>) => void;
    }

    Type Parameters

    • C = undefined
    Index

    Properties

    url?: string
    name: string
    token?: string
    websocketConstructor?: WebSocketLikeConstructor
    connectTimeoutMs?: number
    possibleEvents?: (keyof WebSocketEvents<C>)[]
    identity?: ModuleIdentity
    dependencies?: ModuleDependency[]
    configSchema?: ModuleConfigSchema
    autoConnect?: boolean
    autoReconnect?: boolean
    maxReconnectAttempts?: number
    onError?: (error: unknown) => void
    onClose?: () => void
    onReady?: () => void
    onStateChange?: (context: ClientStateChangeContext) => void
    onAnyMessage?: (data: WebSocketEvent<C>) => void
    onAnySend?: (data: WebSocketEvent<C>) => void