Interface ShardQueryResult<C>`Protected`

A result returned by a ShardQueryFunction querying an individual shard.

interface ShardQueryResult<C extends BaseConfigMap> {
    count: number;
    items: EntityItem<C>[];
    pageKey?: PageKey<C>;
}

Type Parameters

C extends BaseConfigMap
ConfigMap that defines an EntityManager configuration's EntityMap, key properties, and TranscodeMap. If omitted, defaults to BaseConfigMap.

Index

Properties

count items pageKey?

Properties

count

count: number

The number of records returned.

items

items: EntityItem<C>[]

The returned records.

`Optional`pageKey

pageKey?: PageKey<C>

The page key for the next query on this shard.