Interface ShardQueryResult<CC, ET, IT, CF, K>`Protected`

A result returned by a ShardQueryFunction querying an individual shard.

interface ShardQueryResult<
    CC extends BaseConfigMap,
    ET extends EntityToken<CC>,
    IT extends string,
    CF = unknown,
    K = unknown,
> {
    count: number;
    items: Projected<EntityItemByToken<CC, ET>, K>[];
    pageKey?: PageKeyByIndex<CC, ET, IT, CF>;
}

Type Parameters

CC extends BaseConfigMap
ConfigMap.
ET extends EntityToken<CC>
Entity token narrowing the item type.
IT extends string
Index token (for page key typing).
CF = unknown
Optional values-first config literal type for narrowing.
K = unknown
Optional projection keys; narrows item shape when provided.

Index

Properties

count items pageKey?

Properties

count

count: number

The number of records returned.

items

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

The returned records.

`Optional`pageKey

pageKey?: PageKeyByIndex<CC, ET, IT, CF>

The page key for the next query on this shard.