Prometheus Entity Management API
    Preparing search index...

    Interface UseEntityViewOptions<TEntity>

    Configure a live view over a base list: filter/sort/search in JS when data is complete, or compile the same spec to remote params when not. baseQueryKey identifies the underlying id list in the graph; the hook may create additional keys for remote result sets.

    interface UseEntityViewOptions<TEntity extends object> {
        baseQueryKey: unknown[];
        enabled?: boolean;
        initialIds?: string[];
        initialTotal?: number;
        mode?: CompletenessMode;
        normalize?: (raw: TEntity) => { data: TEntity; id: string };
        remoteDebounce?: number;
        remoteFetch?: (params: ViewFetchParams) => Promise<ListResponse<TEntity>>;
        staleTime?: number;
        type: string;
        view: ViewDescriptor;
    }

    Type Parameters

    • TEntity extends object
    Index
    baseQueryKey enabled? initialIds? initialTotal? mode? normalize? remoteDebounce? remoteFetch? staleTime? type view
    baseQueryKey: unknown[]
    enabled?: boolean
    initialIds?: string[]

    SSR-seeded ids written once into lists[baseKey] to avoid empty-state flash before hydration fetch.

    initialTotal?: number

    SSR-seeded total for completeness heuristics when ids are preloaded.

    mode?: CompletenessMode
    normalize?: (raw: TEntity) => { data: TEntity; id: string }
    remoteDebounce?: number
    remoteFetch?: (params: ViewFetchParams) => Promise<ListResponse<TEntity>>
    staleTime?: number
    type: string
    view: ViewDescriptor

    Settings
    Member Visibility

    On This Page
    Properties