Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

  • Metadata

Index

Constructors

constructor

Properties

modelOptions

modelOptions: ModelMetadata<T>

Methods

forProperty

getIndex

  • getIndex(indexName: string): SecondaryIndex<T> | null
  • Parameters

    • indexName: string

    Returns SecondaryIndex<T> | null

    Returns the index if one with given name exists, null otherwise

getIndexes

  • getIndexes(): Array<SecondaryIndex<T>>

getKeysWithUUID

getPartitionKey

  • getPartitionKey(indexName: undefined | string): keyof T
  • Parameters

    • Optional indexName: undefined | string

    Returns keyof T

    Returns the name of partition key (not the db name if it differs from property name)

getSortKey

  • getSortKey(indexName: undefined | string): keyof T | null
  • Parameters

    • Optional indexName: undefined | string

    Returns keyof T | null

    Returns the name of sort key (not the db name if it differs from property name) or null if none was defined