Interface QueryOptions

Extends the basic query builder options by adding an optional sort key condition for more precise querying capabilities.

interface QueryOptions {
    filter?: FilterParams;
    indexName?: string;
    skCondition?: SortKeyCondition;
}

Hierarchy (view full)

Properties

filter? indexName? skCondition?

Properties

Optional filter

filter?: FilterParams

Optional filter conditions to apply to the query.

Optional indexName

indexName?: string

Optional name of the secondary index to use in the query.

Optional skCondition

skCondition?: SortKeyCondition

An optional condition for the sort key to further refine the query. This can be an exact match condition or a condition specifying a range or beginning match for the sort key.

Settings

Member Visibility

Theme

On This Page

filterindexNameskCondition

Generated using TypeDoc