Interface StorageService<T>

Abstract Concept of StorageService

simplified storage-service for NoSQL data.

Type Parameters

T extends StorageModel

Hierarchy

StorageService

Implemented by

Index

Methods

delete hello increment read readOrCreate save update

Methods

delete

delete(id: string): Promise<T>
delete item by id
Parameters
- id: string
  
  unique-id
Returns Promise<T>
- Defined in src/cores/storage/storage-service.ts:79

hello

hello(): string
say hello(name)

Returns
simple service name like storage-service:${name}

Returns string
- Defined in src/cores/storage/storage-service.ts:28

increment

increment(id: string, model: T, $update?: T): Promise<T>
increment number attribute (or overwrite string field)
- NOTE! increments only number type.
Parameters
- id: string
  
  unique-id
- model: T
  
  data (ONLY number is supportable)
- Optional $update: T
  
  (optional) update-set.
Returns Promise<T>
- Defined in src/cores/storage/storage-service.ts:72

read

read(id: string): Promise<T>
read (or error 404 NOT FOUND - id:...)
Parameters
- id: string
  
  unique-id
Returns Promise<T>
- Defined in src/cores/storage/storage-service.ts:35

readOrCreate

readOrCreate(id: string, model: T): Promise<T>
read or create if not-found.
Parameters
- id: string
  
  unique-id
- model: T
  
  auto creation if not-found.
Returns Promise<T>
- Defined in src/cores/storage/storage-service.ts:43

save

save(id: string, model: T): Promise<T>
save (or create) of model.
- WARN! overwrite if exists
Parameters
- id: string
  
  unique-id
- model: T
  
  data.
Returns Promise<T>
- Defined in src/cores/storage/storage-service.ts:52

update

update(id: string, model: T, incrementals?: T): Promise<T>
update some attributes of model
- NOTE! it will create if not exist.
Parameters
- id: string
  
  unique-id
- model: T
  
  data
- Optional incrementals: T
  
  (optional) incrementals like count = count + 1
Returns Promise<T>
- Defined in src/cores/storage/storage-service.ts:62

Generated using TypeDoc