Prometheus Entity Management API
    Preparing search index...

    Interface GraphProviderOptions

    GraphProvider utilities for SolidJS.

    Provides boot-time setup helpers for attaching global focus/reconnect listeners and configuring the engine from within a SolidJS application root.

    Usage in the application root (e.g. src/index.tsx):

    import { setupGraphProvider } from "@prometheus-ags/entity-graph-solid";
    import { configureEngine, attachGlobalListeners } from "@prometheus-ags/entity-graph-core";

    setupGraphProvider({
      staleTime: 60_000,
      revalidateOnFocus: true,
    });
    interface GraphProviderOptions {
        attachListeners?: boolean;
        defaultGcTime?: number;
        defaultStaleTime?: number;
        gcInterval?: number;
        maxRetries?: number;
        retryBaseDelay?: number;
        revalidateOnFocus?: boolean;
        revalidateOnReconnect?: boolean;
        startGc?: boolean;
    }

    Hierarchy (View Summary)

    Index
    attachListeners? defaultGcTime? defaultStaleTime? gcInterval? maxRetries? retryBaseDelay? revalidateOnFocus? revalidateOnReconnect? startGc?
    attachListeners?: boolean

    Whether to attach window focus/online listeners for stale-while-revalidate. Defaults to true in browser environments.

    defaultGcTime?: number

    Max age (Date.now() - lastFetched) for evicting entities with zero subscribers during GC.

    defaultStaleTime?: number
    gcInterval?: number

    Interval between GC passes when the collector is active (default 60s).

    maxRetries?: number
    retryBaseDelay?: number
    revalidateOnFocus?: boolean
    revalidateOnReconnect?: boolean
    startGc?: boolean

    Whether to start the periodic garbage collector. Defaults to true.

    Settings
    Member Visibility

    On This Page
    Properties