Prometheus Entity Management API
    Preparing search index...

    Interface UseEntityViewResult<TEntity>

    Rich list UI state: projected items/viewIds, completeness mode, remote vs local fetching flags, and imperative view updaters. isShowingLocalPending signals hybrid mode where stale local rows are visible while a remote round-trip runs.

    interface UseEntityViewResult<TEntity> {
        clearView: () => void;
        completenessMode: CompletenessMode;
        error: string | null;
        fetchNextPage: () => void;
        hasNextPage: boolean;
        isError: boolean;
        isFetching: boolean;
        isFetchingMore: boolean;
        isLoading: boolean;
        isLocallyComplete: boolean;
        isRemoteFetching: boolean;
        isShowingLocalPending: boolean;
        items: TEntity[];
        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

    • TEntity
    Index
    clearView completenessMode error fetchNextPage hasNextPage isError isFetching isFetchingMore isLoading isLocallyComplete isRemoteFetching isShowingLocalPending items refetch setFilter setSearch setSort setView viewIds viewTotal
    clearView: () => void
    completenessMode: CompletenessMode
    error: string | null

    Last error message from the remote fetcher (or the cached base list state). null when the latest attempt succeeded or no attempt has been made.

    fetchNextPage: () => void
    hasNextPage: boolean
    isError: boolean

    Convenience for error !== null. TanStack-Query-style.

    isFetching: boolean
    isFetchingMore: boolean
    isLoading: boolean
    isLocallyComplete: boolean
    isRemoteFetching: boolean
    isShowingLocalPending: boolean
    items: TEntity[]
    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

    Settings
    Member Visibility

    On This Page
    Properties