Interface ShardQueryResult<Item, EntityToken, M, HashKey, RangeKey, T>

A result returned by a ShardQueryFunction querying an individual shard.

interface ShardQueryResult<Item, EntityToken, M, HashKey, RangeKey, T> {
    count: number;
    items: Item[];
    pageKey?: Partial<Pick<Item, keyof {
        [Property in string | number | symbol as [T[keyof T]] extends [never]
            ? [NonNullable<Item[Property]>] extends [never]
                ? Property
                : never
            : [NonNullable<Item[Property]>] extends [never]
                ? never
                : NonNullable<Item[Property]> extends T[keyof T]
                    ? Property
                    : never]: never
    }>>;
}

Type Parameters

Properties

count items pageKey?

Properties

count

count: number

The number of records returned.

items

items: Item[]

The returned records.

OptionalpageKey

pageKey?: Partial<Pick<Item, keyof {
    [Property in string | number | symbol as [T[keyof T]] extends [never]
        ? [NonNullable<Item[Property]>] extends [never]
            ? Property
            : never
        : [NonNullable<Item[Property]>] extends [never]
            ? never
            : NonNullable<Item[Property]> extends T[keyof T]
                ? Property
                : never]: never
}>>

The page key for the next query on this shard.

Settings

Member Visibility

On This Page

Properties