Prometheus Entity Management API
    Preparing search index...

    Interface UseEntityQueryResult<T>

    interface UseEntityQueryResult<T> {
        clearView: () => void;
        completenessMode: CompletenessMode;
        error: TerminalError | TransientError | null;
        fetchNextPage: () => void;
        hasNextPage: boolean;
        isError: boolean;
        isFetching: boolean;
        isFetchingMore: boolean;
        isLoading: boolean;
        isLocallyComplete: boolean;
        isShowingLocalPending: boolean;
        items: T[];
        refetch: () => void;
        setFilter: (f: FilterSpec | null) => void;
        setSearch: (q: string) => void;
        setSort: (s: SortSpec | null) => void;
        setView: (v: Partial<ViewDescriptor>) => void;
        viewIds: string[];
        viewTotal: number | null;
    }

    Type Parameters

    • T
    Index
    clearView completenessMode error fetchNextPage hasNextPage isError isFetching isFetchingMore isLoading isLocallyComplete isShowingLocalPending items refetch setFilter setSearch setSort setView viewIds viewTotal
    clearView: () => void

    Reset view to the initial descriptor.

    completenessMode: CompletenessMode

    Resolved completeness mode for the current view.

    error: TerminalError | TransientError | null

    Typed error — instanceof TerminalError (4xx) or instanceof TransientError (5xx/network). null on success.

    fetchNextPage: () => void

    Load the next page of results.

    hasNextPage: boolean

    True when there are more pages to load.

    isError: boolean

    True when the last attempt ended with any error.

    isFetching: boolean

    True while any fetch (initial or page) is in-flight.

    isFetchingMore: boolean

    True while a paginated "load more" fetch is in-flight.

    isLoading: boolean

    True while the very first page is loading with zero cached rows.

    isLocallyComplete: boolean

    Whether local graph data is complete for the current view.

    isShowingLocalPending: boolean

    True when completenessMode === "hybrid" and remote is still in-flight while local rows are displayed.

    items: T[]

    Projected entity rows visible through the current view.

    refetch: () => void

    Force a fresh fetch (bypasses staleTime).

    setFilter: (f: FilterSpec | null) => void

    Replace the active filter spec.

    setSearch: (q: string) => void

    Update free-text search query.

    setSort: (s: SortSpec | null) => void

    Replace the active sort spec.

    setView: (v: Partial<ViewDescriptor>) => void

    Merge partial view descriptor updates.

    viewIds: string[]

    All ids in the projected view (for virtualised renderers).

    viewTotal: number | null

    Server-reported total or local count if complete, else null.

    Settings
    Member Visibility

    On This Page
    Properties