Type alias SortKeyAttribute<T>

SortKeyAttribute<T>: {
    [K in keyof T]: T[K] extends SortKey
        ? K
        : never
}[keyof T]

Represents the type of the sort key attribute for a given entity. It identifies the specific property of the entity that is marked as the sort key, used in conjunction with the partition key to provide additional sorting capability within the database.

Type Parameters

  • T

    The type of the entity being examined.

Returns

The name of the sort key attribute as a string if one exists; otherwise, the result is never.

Generated using TypeDoc