@karmaniverous/entity-manager
    Preparing search index...

    Interface QueryResult<CC, ET, ITS, K>Protected

    A result returned by a query across multiple shards, where each shard may receive multiple page queries via a dynamically-generated ShardQueryFunction.

    interface QueryResult<
        CC extends BaseConfigMap,
        ET extends EntityToken<CC>,
        ITS extends string,
        K = unknown,
    > {
        count: number;
        items: Projected<EntityItemByToken<CC, ET>, K>[];
        pageKeyMap: string;
    }

    Type Parameters

    • CC extends BaseConfigMap

      ConfigMap.

    • ET extends EntityToken<CC>

      Entity token narrowing the result item type.

    • ITS extends string

      Index token subset (carried for symmetry; not represented in the shape).

    • K = unknown

      Optional projection keys; narrows item shape when provided.

    Index

    Properties

    count items pageKeyMap

    Properties

    count: number

    Total number of records returned across all shards.

    items: Projected<EntityItemByToken<CC, ET>, K>[]

    The returned records.

    pageKeyMap: string

    A compressed, two-layer map of page keys, used to query the next page of data for a given sort key on each shard of a given hash key.

    Settings

    Member Visibility

    On This Page

    Properties