Class DynamoStorageService<T>

class: DynamoStorageService

service via DynamoDB with id + json data.

Type Parameters

T extends StorageModel

Hierarchy

DynamoStorageService

Implements

StorageService<T>

Index

Constructors

Properties

$dynamo _fields _idName _table

Methods

delete fields hello increment read readOrCreate save update

Constructors

constructor

new DynamoStorageService<T>(table: string, fields: string[], idName?: string, idType?: KEY_TYPE): DynamoStorageService<T>
Type Parameters
- T extends StorageModel
Parameters
- table: string
- fields: string[]
- idName: string = 'id'
- idType: KEY_TYPE = 'string'
Returns DynamoStorageService<T>
- Defined in src/cores/storage/storage-service.ts:106

Properties

`Private` $dynamo

$dynamo: DynamoService<MyGeneral>

`Private` _fields

_fields: string[]

`Private` _idName

_idName: string

`Private` _table

_table: string

Methods

delete

delete(id: string): Promise<T>
delete set.
- if not exists, then just update property with base zero 0.
Parameters
- id: string
  
  id
Returns Promise<T>
Implementation of StorageService.delete
- Defined in src/cores/storage/storage-service.ts:242

fields

fields(): string[]
(extended) get copy of fields.

Returns string[]
- Defined in src/cores/storage/storage-service.ts:123

hello

hello(): string
say hello()

Returns string
Implementation of StorageService.hello
- Defined in src/cores/storage/storage-service.ts:118

increment

increment(id: string, model: T, $update?: T): Promise<T>
increment number attribute (or overwrite string field)
- if not exists, then just update property with base zero 0.
Parameters
- id: string
  
  id
- model: T
  
  attributes of number.
- Optional $update: T
  
  (optional) update-set.
Returns Promise<T>
Implementation of StorageService.increment
- Defined in src/cores/storage/storage-service.ts:206

read

read(id: string): Promise<T>
Read whole model via database.
Parameters
- id: string
  
  id
Returns Promise<T>
Implementation of StorageService.read
- Defined in src/cores/storage/storage-service.ts:130

readOrCreate

readOrCreate(id: string, model: T): Promise<T>
auto-create if not found.
Parameters
- id: string
- model: T
Returns Promise<T>
Implementation of StorageService.readOrCreate
- Defined in src/cores/storage/storage-service.ts:147

save

save(id: string, model: T): Promise<T>
simply save(or overwrite) all model
Parameters
- id: string
  
  id
- model: T
  
  whole object.
Returns Promise<T>
Implementation of StorageService.save
- Defined in src/cores/storage/storage-service.ts:160

update

update(id: string, model: T, incrementals?: T): Promise<T>
update some attributes
Parameters
- id: string
  
  id
- model: T
  
  attributes to update
- Optional incrementals: T
  
  (optional) attributes to increment
Returns Promise<T>
Implementation of StorageService.update
- Defined in src/cores/storage/storage-service.ts:179

Generated using TypeDoc