Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

  • Metadata

Index

Constructors

constructor

Properties

modelOptions

modelOptions: ModelMetadata<T>

Methods

Private filterBy

  • filterBy<R>(predicate: function, defaultValue: R): Array<PropertyMetadata<any>> | R

Private filterByFirst

forProperty

getIndex

getIndexes

getKeysWithUUID

getPartitionKey

  • getPartitionKey(indexName?: undefined | string): keyof T
  • throws

    Throws an error if no partition key was defined for the current model

    throws

    Throws an error if an indexName was delivered but no index was found for given name

    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
  • throws

    Throws an error if an indexName was delivered but no index was found for given name or the found index has no sort key defined

    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

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc