Interface QueryReturn<E, T>

Return type for query method.

interface QueryReturn<
    E extends Entity,
    T extends TranscodeRegistry = DefaultTranscodeRegistry,
> {
    count: number;
    items: E[];
    pageKey?: E | Pick<E, TranscodableProperties<E, T>>;
}

Type Parameters

E extends Entity
Entity type.
T extends TranscodeRegistry = DefaultTranscodeRegistry
TranscodeRegistry indicating transcodable types. Defaults to DefaultTranscodeRegistry.

Index

Properties

count items pageKey?

Properties

count

count: number

Number of records returned in this result set, exclusive of other pages.

items

items: E[]

Records returned in this result set.

`Optional`pageKey

pageKey?: E | Pick<E, TranscodableProperties<E, T>>

If limit was reached, pageKey will be provided for next page.