Options
All
  • Public
  • Public/Protected
  • All
Menu

A Mapper is responsible to define how a specific type is mapped to an attribute value which can be stored in dynamodb and how to parse the value from dynamodb back into the specific type

Type parameters

  • T

Hierarchy

  • MapperForType

Implemented by

Index

Methods

Methods

fromDb

  • fromDb(attributeValue: AttributeValue, propertyMetadata?: PropertyMetadata<T>): T

toDb

  • toDb(propertyValue: T, propertyMetadata?: PropertyMetadata<T>): AttributeValue | null
  • Maps a js value to an attribute value so it can be stored in dynamodb, supported types are

    S(tring) N(umber) B(inary) BOOL NULL S(tring)S(et) N(umber)S(et) B(inary)S(et) L(ist)

    Parameters

    Returns AttributeValue | null

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