Type alias ListOptionsPkParams<Bag, T>

ListOptionsPkParams<Bag, T>: T["identifier"]["sk"] extends never
    ? unknown
    : Prettify<Partial<IndexQueryInput<Bag, T["identifier"]>>>

Models with composite PKs defined are expected to contain the model's pk, sk, and sortDirection properties in the options param

Type Parameters

Returns

an object containing additional options properties for models with a composite primary index

Settings

Member Visibility

Theme