Prometheus Entity Management API
    Preparing search index...

    Interface CreateEntityListReturn<TEntity>

    Return value of createEntityList. Items are fine-grained: each row is individually reactive via SolidJS signals.

    interface CreateEntityListReturn<TEntity extends object> {
        error: () => string | null;
        fetchNextPage: () => Promise<void>;
        hasNextPage: () => boolean;
        hasPrevPage: () => boolean;
        isLoading: () => boolean;
        isLoadingMore: () => boolean;
        items: () => TEntity[];
        listState: () => ListState;
        refetch: () => Promise<void>;
        total: () => number | null;
        typedError: () => EntityError | null;
    }

    Type Parameters

    • TEntity extends object
    Index
    error fetchNextPage hasNextPage hasPrevPage isLoading isLoadingMore items listState refetch total typedError
    error: () => string | null

    List fetch error string, or null.

    fetchNextPage: () => Promise<void>

    Fetch the next page (appends when mode is "append").

    hasNextPage: () => boolean

    true when a next page is available.

    hasPrevPage: () => boolean

    true when a previous page is available.

    isLoading: () => boolean

    true while the initial list fetch is in-flight.

    isLoadingMore: () => boolean

    true while a "load more" / pagination fetch is in-flight.

    items: () => TEntity[]

    Resolved entity objects in list order (ids joined to graph at read time).

    listState: () => ListState

    Raw ListState slice for advanced pagination/meta access.

    refetch: () => Promise<void>

    Refetch the list from scratch (replaces ids).

    total: () => number | null

    Total entity count from the server (may be null before first fetch).

    typedError: () => EntityError | null

    Typed error instance for instanceof checks.

    Settings
    Member Visibility

    On This Page
    Properties