Arc.React
    Preparing search index...

    Interface ArcProps

    Properties for the Arc context component.

    interface ArcProps {
        apiBasePath?: string;
        basePath?: string;
        children?: Element | Element[];
        development?: boolean;
        httpHeadersCallback?: any;
        microservice?: string;
        observableQueryTransferMode?: any;
        origin?: string;
        queryCacheRetentionMs?: number;
        queryConnectionCount?: number;
        queryDirectMode?: boolean;
        queryTransportMethod?: any;
    }
    Index

    Properties

    apiBasePath? basePath? children? development? httpHeadersCallback? microservice? observableQueryTransferMode? origin? queryCacheRetentionMs? queryConnectionCount? queryDirectMode? queryTransportMethod?

    Properties

    apiBasePath?: string
    basePath?: string
    children?: Element | Element[]
    development?: boolean
    httpHeadersCallback?: any
    microservice?: string
    observableQueryTransferMode?: any

    Controls how observable query updates are transferred and exposed. ObservableQueryTransferMode.Delta (default) computes per-update deltas for use with the {@code useChangeStream} hook. 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 before evicting the subscription and cached data.

    A non-zero value lets users navigate away and back quickly without seeing a loading flash — cached data is shown immediately while the fresh subscription re-establishes in the background. Defaults to Globals.queryCacheRetentionMs (30 000 ms). Set to 0 to restore immediate eviction.

    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 ArcProps.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

    The transport method used for observable query subscriptions. Defaults to QueryTransportMethod.ServerSentEvents.

    Settings

    Member Visibility

    On This Page

    Properties