mapper | @shiftcoders/dynamo-easy

Index

Classes

Interfaces

Type aliases

Object literals

Type aliases

Attribute

AttributeCollectionType

AttributeCollectionType: "SS" | "NS" | "BS" | "L"

AttributeType

AttributeType: "S" | "N" | "B" | "M" | "NULL" | "BOOL" | AttributeCollectionType

AttributeValueType

Attributes

Attributes: Record<keyof T | string, Attribute>

CollectionAttributeTypes

CollectionAttributeTypes: StringSetAttribute | NumberSetAttribute | BinarySetAttribute | ListAttribute | NullAttribute

FromDbFn

FromDbFn: function

Type declaration

- (attributeValue: R, propertyMetadata: PropertyMetadata<T, R>): T
- Parameters
  - attributeValue: R
  - Optional propertyMetadata: PropertyMetadata<T, R>
  Returns T

ToDbFn

ToDbFn: function

Type declaration

- (propertyValue: T, propertyMetadata: PropertyMetadata<T, R>): R | null
- Parameters
  - propertyValue: T
  - Optional propertyMetadata: PropertyMetadata<T, R>
  Returns R | null

Functions

booleanFromDb

booleanFromDb(attributeValue: BooleanAttribute): boolean

- Defined in mapper/for-type/boolean.mapper.ts:7
Parameters
- attributeValue: BooleanAttribute
Returns boolean

booleanToDb

booleanToDb(modelValue: boolean): BooleanAttribute

- Defined in mapper/for-type/boolean.mapper.ts:14
Parameters
- modelValue: boolean
Returns BooleanAttribute

collectionFromDb

collectionFromDb(attributeValue: CollectionAttributeTypes, propertyMetadata: PropertyMetadata<any, CollectionAttributeTypes>): any[] | Set<any>

- Defined in mapper/for-type/collection.mapper.ts:26
Parameters
- attributeValue: CollectionAttributeTypes
- Optional propertyMetadata: PropertyMetadata<any, CollectionAttributeTypes>
Returns any[] | Set<any>

collectionToDb

collectionToDb(propertyValue: any[] | Set<any>, propertyMetadata: PropertyMetadata<any, CollectionAttributeTypes>): CollectionAttributeTypes | null

- Defined in mapper/for-type/collection.mapper.ts:62
Parameters
- propertyValue: any[] | Set<any>
- Optional propertyMetadata: PropertyMetadata<any, CollectionAttributeTypes>
Returns CollectionAttributeTypes | null

createToKeyFn

createToKeyFn<T>(modelConstructor: ModelConstructor<T>): function

- Defined in mapper/mapper.ts:170
Type parameters
- T
Parameters
- modelConstructor: ModelConstructor<T>
Returns function
- - (item: Partial<T>): Attributes<T>
  - Parameters
    - item: Partial<T>
    Returns Attributes<T>

dateFromDb

dateFromDb(attributeValue: StringAttribute): Date

- Defined in mapper/custom/date-to-string.mapper.ts:7
Parameters
- attributeValue: StringAttribute
Returns Date

dateFromDb

dateFromDb(attributeValue: NumberAttribute): Date

- Defined in mapper/custom/date-to-number.mapper.ts:7
Parameters
- attributeValue: NumberAttribute
Returns Date

dateToDb

dateToDb(modelValue: Date): StringAttribute

- Defined in mapper/custom/date-to-string.mapper.ts:19
Parameters
- modelValue: Date
Returns StringAttribute

dateToDb

dateToDb(modelValue: Date): NumberAttribute

- Defined in mapper/custom/date-to-number.mapper.ts:15
Parameters
- modelValue: Date
Returns NumberAttribute

detectCollectionTypeFromMetadata

detectCollectionTypeFromMetadata(propertyMetadata: PropertyMetadata<any, CollectionAttributeTypes>, propertyValue: any): AttributeCollectionType

- Defined in mapper/for-type/collection.mapper.ts:121
Parameters
- propertyMetadata: PropertyMetadata<any, CollectionAttributeTypes>
- propertyValue: any
Returns AttributeCollectionType

enumFromDb

enumFromDb(attributeValue: NumberAttribute, propertyMetadata: PropertyMetadata<any, NumberAttribute>): string | number

- Defined in mapper/for-type/enum.mapper.ts:19
Parameters
- attributeValue: NumberAttribute
- Optional propertyMetadata: PropertyMetadata<any, NumberAttribute>
Returns string | number

enumToDb

enumToDb(value: string | number, propertyMetadata: PropertyMetadata<any, NumberAttribute>): NumberAttribute

- Defined in mapper/for-type/enum.mapper.ts:8
Parameters
- value: string | number
- Optional propertyMetadata: PropertyMetadata<any, NumberAttribute>
Returns NumberAttribute

fromDb

fromDb<T>(attributeMap: Attributes<T>, modelConstructor: ModelConstructor<T>): T

- Defined in mapper/mapper.ts:239
Type parameters
- T
Parameters
- attributeMap: Attributes<T>
- Optional modelConstructor: ModelConstructor<T>
Returns T

fromDbOne

fromDbOne<T>(attributeValue: Attribute, propertyMetadata: PropertyMetadata<any, any>): T

- Defined in mapper/mapper.ts:287
Type parameters
- T
Parameters
- attributeValue: Attribute
- Optional propertyMetadata: PropertyMetadata<any, any>
Returns T

nullFromDb

nullFromDb(attributeValue: NullAttribute): null

- Defined in mapper/for-type/null.mapper.ts:7
Parameters
- attributeValue: NullAttribute
Returns null

nullToDb

nullToDb(value: null): NullAttribute

- Defined in mapper/for-type/null.mapper.ts:15
Parameters
- value: null
Returns NullAttribute

numberFromDb

numberFromDb(attributeValue: NumberAttribute): number

- Defined in mapper/for-type/number.mapper.ts:8
Parameters
- attributeValue: NumberAttribute
Returns number

numberToDb

numberToDb(modelValue: number): NumberAttribute | null

- Defined in mapper/for-type/number.mapper.ts:20
Parameters
- modelValue: number
Returns NumberAttribute | null

objectFromDb

objectFromDb(val: MapAttribute, propertyMetadata: PropertyMetadata<any, MapAttribute>): any

- Defined in mapper/for-type/object.mapper.ts:9
Parameters
- val: MapAttribute
- Optional propertyMetadata: PropertyMetadata<any, MapAttribute>
Returns any

objectToDb

objectToDb(modelValue: any, propertyMetadata: PropertyMetadata<any, MapAttribute>): MapAttribute

- Defined in mapper/for-type/object.mapper.ts:18
Parameters
- modelValue: any
- Optional propertyMetadata: PropertyMetadata<any, MapAttribute>
Returns MapAttribute

stringFromDb

stringFromDb(attributeValue: StringAttribute): string

- Defined in mapper/for-type/string.mapper.ts:7
Parameters
- attributeValue: StringAttribute
Returns string

stringToDb

stringToDb(modelValue: string): StringAttribute | null

- Defined in mapper/for-type/string.mapper.ts:15
Parameters
- modelValue: string
Returns StringAttribute | null

toDb

toDb<T>(item: T, modelConstructor: ModelConstructor<T>): Attributes<T>

- Defined in mapper/mapper.ts:37
Type parameters
- T
Parameters
- item: T
- Optional modelConstructor: ModelConstructor<T>
Returns Attributes<T>

toDbOne

toDbOne(propertyValue: any, propertyMetadata: PropertyMetadata<any>): Attribute | null
toDbOne(propertyValue: any, propertyPath: string, propertyMetadata: PropertyMetadata<any>): Attribute | null

- Defined in mapper/mapper.ts:107
Parameters
- propertyValue: any
- Optional propertyMetadata: PropertyMetadata<any>
Returns Attribute | null
- Defined in mapper/mapper.ts:117
Parameters
- propertyValue: any
- propertyPath: string
- Optional propertyMetadata: PropertyMetadata<any>
Returns Attribute | null

toKey

toKey<T>(item: T, modelConstructor: ModelConstructor<T>): Attributes<T>

- Defined in mapper/mapper.ts:196
Type parameters
- T
Parameters
- item: T
- modelConstructor: ModelConstructor<T>
Returns Attributes<T>

Object literals

Const BooleanMapper

BooleanMapper: object

fromDb

fromDb: booleanFromDb = booleanFromDb

toDb

toDb: booleanToDb = booleanToDb

Const CollectionMapper

CollectionMapper: object

fromDb

fromDb: collectionFromDb = collectionFromDb

toDb

toDb: collectionToDb = collectionToDb

Const EnumMapper

EnumMapper: object

fromDb

fromDb: enumFromDb = enumFromDb

toDb

toDb: enumToDb = enumToDb

Const NullMapper

NullMapper: object

fromDb

fromDb: nullFromDb = nullFromDb

toDb

toDb: nullToDb = nullToDb

Const NumberMapper

NumberMapper: object

fromDb

fromDb: numberFromDb = numberFromDb

toDb

toDb: numberToDb = numberToDb

Const ObjectMapper

ObjectMapper: object

fromDb

fromDb: objectFromDb = objectFromDb

toDb

toDb: objectToDb = objectToDb

Const StringMapper

StringMapper: object

fromDb

fromDb: stringFromDb = stringFromDb

toDb

toDb: stringToDb = stringToDb

Const dateToNumberMapper

dateToNumberMapper: object

fromDb

fromDb: dateFromDb = dateFromDb

toDb

toDb: dateToDb = dateToDb

Const dateToStringMapper

dateToStringMapper: object

fromDb

fromDb: dateFromDb = dateFromDb

toDb

toDb: dateToDb = dateToDb

Index

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

Attribute

AttributeCollectionType

AttributeType

AttributeValueType

Attributes

CollectionAttributeTypes

FromDbFn

Type declaration

Parameters

attributeValue: R

Optional propertyMetadata: PropertyMetadata<T, R>

Returns T

ToDbFn

Type declaration

Parameters

propertyValue: T

Optional propertyMetadata: PropertyMetadata<T, R>

Returns R | null

Functions

booleanFromDb

Parameters

attributeValue: BooleanAttribute

Returns boolean

booleanToDb

Parameters

modelValue: boolean

Returns BooleanAttribute

collectionFromDb

Parameters

attributeValue: CollectionAttributeTypes

Optional propertyMetadata: PropertyMetadata<any, CollectionAttributeTypes>

Returns any[] | Set<any>

collectionToDb

Parameters

propertyValue: any[] | Set<any>

Optional propertyMetadata: PropertyMetadata<any, CollectionAttributeTypes>

Returns CollectionAttributeTypes | null

createToKeyFn

Type parameters

T

Parameters

modelConstructor: ModelConstructor<T>

Returns function

Parameters

item: Partial<T>

Returns Attributes<T>

dateFromDb

Parameters

attributeValue: StringAttribute

Returns Date

dateFromDb

Parameters

attributeValue: NumberAttribute

Returns Date

dateToDb

Parameters

modelValue: Date

Returns StringAttribute

dateToDb

Parameters

modelValue: Date

Returns NumberAttribute

detectCollectionTypeFromMetadata

Parameters

propertyMetadata: PropertyMetadata<any, CollectionAttributeTypes>

propertyValue: any

Returns AttributeCollectionType

enumFromDb

Parameters

attributeValue: NumberAttribute

Optional propertyMetadata: PropertyMetadata<any, NumberAttribute>

Returns string | number

enumToDb