Arc.React
    Preparing search index...

    Interface ArcConfiguration

    interface ArcConfiguration {
        apiBasePath?: string;
        basePath?: string;
        development?: boolean;
        httpHeadersCallback?: any;
        messenger?: any;
        microservice: string;
        observableQueryDiagnostics?: any;
        observableQueryTransferMode?: any;
        origin?: string;
        queryCacheRetentionMs?: number;
        queryConnectionCount?: number;
        queryDirectMode?: boolean;
        queryTransportMethod?: any;
        queryVersion?: number;
        reconnectQueries?: () => void;
    }
    Index

    Properties

    apiBasePath? basePath? development? httpHeadersCallback? messenger? microservice observableQueryDiagnostics? observableQueryTransferMode? origin? queryCacheRetentionMs? queryConnectionCount? queryDirectMode? queryTransportMethod? queryVersion? reconnectQueries?

    Properties

    apiBasePath?: string
    basePath?: string
    development?: boolean
    httpHeadersCallback?: any
    messenger?: any
    microservice: string
    observableQueryDiagnostics?: any

    Diagnostics service that exposes live snapshots of observable query state. Consumers can call IObservableQueryDiagnostics.getSnapshot to retrieve a point-in-time view, or IObservableQueryDiagnostics.subscribe to be notified whenever a new snapshot is produced.

    observableQueryTransferMode?: any

    Controls how observable query updates are transferred and exposed. ObservableQueryTransferMode.Delta (default) computes per-update deltas; ObservableQueryTransferMode.Full delivers the whole collection on every update.

    origin?: string
    queryCacheRetentionMs?: number

    How long in milliseconds to retain a query cache entry after the last subscriber releases it. Mirrors Globals.queryCacheRetentionMs. Defaults to 30 000 ms.

    queryConnectionCount?: number

    Number of hub connections maintained for observable queries. When greater than one, queries are distributed across the pool round-robin. Only applies when queryTransportMethod is a centralized hub transport. Defaults to 1.

    queryDirectMode?: boolean

    When true, observable queries connect directly to the per-query WebSocket URL instead of routing through the centralized hub endpoint. Defaults to false (use the centralized hub).

    queryTransportMethod?: any
    queryVersion?: number

    Monotonically increasing version counter that is bumped by reconnectQueries so that query hook effects re-run and re-establish subscriptions through fresh transport connections. Do not set this directly.

    reconnectQueries?: () => void

    Tears down all active query subscriptions, disposes the shared multiplexer, and forces every observable query hook to re-subscribe through a fresh connection.

    Call this after an authentication state change (e.g. login or logout) so that new WebSocket or SSE connections are established with the updated credentials (cookies, headers).

    Settings

    Member Visibility

    On This Page

    Properties