Interface CreateEntityReturn<TEntity>

Return value of createEntity. All fields are SolidJS signals (fine-grained, no re-render of unrelated parts).

interface CreateEntityReturn<TEntity extends object> {
    data: () => TEntity | null;
    entityState: () => EntityState;
    error: () => string | null;
    isLoading: () => boolean;
    isRefetching: () => boolean;
    refetch: () => Promise<void>;
    typedError: () => EntityError | null;
}

Properties

data: () => TEntity | null

The merged entity (canonical + patch overlay) or null when not yet loaded.

entityState: () => EntityState

Raw EntityState slice for advanced use (isFetching, stale, lastFetched).

error: () => string | null

Per-entity fetch error string from the graph, or null.

isLoading: () => boolean

true while the initial or background fetch is in-flight.

isRefetching: () => boolean

true only during background SWR refetch (data already present).

refetch: () => Promise<void>

Imperatively trigger a refetch, bypassing staleness checks.

typedError: () => EntityError | null

Typed EntityError instance (TerminalError | TransientError) so consumers can instanceof-check the failure mode without string parsing.