Interface UseEntitiesResult<T>

Five-field return — the entirety of what a list consumer needs for the common case.

interface UseEntitiesResult<T> {
    error: TerminalError | TransientError | null;
    isError: boolean;
    isLoading: boolean;
    items: T[];
    refetch: () => void;
}

Properties

Typed error instance — instanceof TerminalError (4xx) or instanceof TransientError (5xx/network).

isError: boolean

True when the last attempt ended with any error (terminal or transient).

isLoading: boolean

True only while the very first attempt is in-flight with no cached rows yet.

items: T[]

Resolved entity rows in the graph for this query, in server order.

refetch: () => void

Manually trigger a fresh fetch (bypasses staleTime).