UpdateFunctions | @shiftcoders/dynamo-easy

Type parameters

T
R

Hierarchy

UpdateFunctions

Index

Properties

Properties

add

add: function

Type declaration

- (values: T | Array<ExtractListType<T>> | Set<ExtractListType<T>>): R
- Parameters
  - values: T | Array<ExtractListType<T>> | Set<ExtractListType<T>>
  Returns R

appendToList

appendToList: function

Type declaration

- (value: T | Array<ExtractListType<T>> | Set<ExtractListType<T>>, position: "START" | "END"): R
- Parameters
  - value: T | Array<ExtractListType<T>> | Set<ExtractListType<T>>
  - Optional position: "START" | "END"
  Returns R

decrementBy

decrementBy: function

Type declaration

- (value: T): R
- Parameters
  - value: T
  Returns R

incrementBy

incrementBy: function

Type declaration

- (value: T): R
- Parameters
  - value: T
  Returns R

remove

remove: function

Type declaration

- (): R
- Returns R

removeFromListAt

removeFromListAt: function

Type declaration

- (positions: number[]): R
- Parameters
  - Rest positions: number[]
  Returns R

removeFromSet

removeFromSet: function

Type declaration

- (values: T | Array<ExtractListType<T>> | Set<ExtractListType<T>>): R
- Parameters
  - values: T | Array<ExtractListType<T>> | Set<ExtractListType<T>>
  Returns R

set

set: function

Type declaration

- (value: T, ifNotExists: undefined | false | true): R
- Parameters
  - value: T
  - Optional ifNotExists: undefined | false | true
  Returns R