Class AbstractManager<T, S, ModelType>`Abstract`

class: AbstractManager

abstract model manager to cover all models which extend CoreModel.
feature to handle 'name' like unique value in same type.
typed-storage based.

Abstract

Type Parameters

T extends CoreModel<ModelType>
S extends StorageMakeable<T, ModelType>
ModelType extends string

Hierarchy

GeneralModelFilter<T, ModelType>
- AbstractManager
  - CoreManager

Index

Constructors

`Protected` constructor

new AbstractManager<T, S, ModelType>(type: ModelType, parent: S, fields: string[], uniqueField?: string, ns?: string): AbstractManager<T, S, ModelType>
default constructor
Type Parameters
- T extends CoreModel<ModelType, T>
- S extends StorageMakeable<T, ModelType, S>
- ModelType extends string
Parameters
- type: ModelType
  
  model type string
- parent: S
  
  service instance which implements StorageMakeable interface
- fields: string[]
  
  list of model field names
- Optional uniqueField: string
  
  (optional) unique field name
- Optional ns: string
  
  (optional) namespace to be printed. pass NULL to suppress all logs. global NS value will be used if not specified or undefined.
Returns AbstractManager<T, S, ModelType>
Overrides GeneralModelFilter.constructor
- Defined in src/cores/storage/model-manager.ts:42

Properties

`Readonly` $unique

$unique: UniqueFieldManager<T, ModelType>

`Readonly` FIELDS

FIELDS: string[]

`Readonly` NS

NS: string

`Readonly` parent

parent: S

`Readonly` storage

storage: TypedStorageService<T, ModelType>

Accessors

type

get type(): ModelType
type getter

Returns ModelType
- Defined in src/cores/storage/model-manager.ts:58

Methods

`Private` _updateModel

_updateModel(id: string, model: T, $inc?: T, isCreate?: boolean): Promise<T>
Private
internal implementation for 'update' and 'updateOrCreate'
Parameters
- id: string
  
  model id
- model: T
  
  model object
- Optional $inc: T
  
  (optional) incremental set
- isCreate: boolean = true
  
  (optional) flag to allow creating a new model (default: true)
Returns Promise<T>
- Defined in src/cores/storage/model-manager.ts:182

afterRead

afterRead(model: T, origin?: T): T
parse .meta to json
Parameters
- model: T
  
  the current model
- Optional origin: T
  
  the origin model
Returns T
Inherited from GeneralModelFilter.afterRead
- Defined in src/cores/storage/proxy-storage-service.ts:144

afterSave

afterSave(model: T, origin?: T): T
called after saving the model.
- parse .meta back to json object.
Parameters
- model: T
  
  the saved model
- Optional origin: T
  
  the origin model.
Returns T
Inherited from GeneralModelFilter.afterSave
- Defined in src/cores/storage/proxy-storage-service.ts:239

afterUpdate

afterUpdate(model: T): T
called after updating the model.
Parameters
- model: T
  
  the updated model
Returns T
Inherited from GeneralModelFilter.afterUpdate
- Defined in src/cores/storage/proxy-storage-service.ts:256

beforeSave

beforeSave(model: T, origin?: T): T
filter for before saving.
- make sure data conversion
- move the unknown fields to .meta.
Parameters
- model: T
  
  the current model
- Optional origin: T
  
  the origin model
Returns T
Inherited from GeneralModelFilter.beforeSave
- Defined in src/cores/storage/proxy-storage-service.ts:160

beforeUpdate

beforeUpdate(model: T, incrementals?: T): T
called before updating the model.
Parameters
- model: T
  
  the updated model
- Optional incrementals: T
  
  (optional) incremental fields.
Returns T
Inherited from GeneralModelFilter.beforeUpdate
- Defined in src/cores/storage/proxy-storage-service.ts:248

delete

delete(id: string, destroy?: boolean): Promise<T>
default implementation of deleting model
Parameters
- id: string
  
  model id
- destroy: boolean = true
  
  flag for hard delete or soft delete (by setting 'deletedAt' field)
Returns Promise<T>
- Defined in src/cores/storage/model-manager.ts:162

hello

hello(): string
hello of this service-identity

Returns string
- Defined in src/cores/storage/model-manager.ts:53

insert

insert(model: T): Promise<T>
default implementation of 'inserting' model
Parameters
- model: T
  
  model object
Returns Promise<T>
- Defined in src/cores/storage/model-manager.ts:103

onBeforeSave

onBeforeSave(model: T, origin?: T): T
callback invoked just before the model is saved
- override this to customize default behavior to perform model validation, cleansing or normalization
Parameters
- model: T
  
  model object
- Optional origin: T
  
  original model currently in the storage
Returns T
Overrides GeneralModelFilter.onBeforeSave
- Defined in src/cores/storage/model-manager.ts:76

prepare

prepare(id: string, $def?: T, isCreate?: boolean): Promise<T>
default implementation of 'preparing' model
- prepare model w/ safe creation
Parameters
- id: string
  
  model-id to prepare
- Optional $def: T
  
  default model value
- isCreate: boolean = true
  
  (optional) flag to allow creating a new model (default: true)
Returns Promise<T>
- Defined in src/cores/storage/model-manager.ts:87

`Protected` `Abstract` prepareDefault

prepareDefault($def: T): T
prepare default model when creation
- sub classes should implement this method
Abstract
Parameters
- $def: T
  
  default model
Returns T
- Defined in src/cores/storage/model-manager.ts:68

retrieve

retrieve(id: string): Promise<T>
default implementation of 'retrieving' model
Parameters
- id: string
  
  model id
Returns Promise<T>
- Defined in src/cores/storage/model-manager.ts:125

update

update(id: string, model: T, $inc?: T): Promise<T>
default implementation of updating model
Parameters
- id: string
  
  model id
- model: T
  
  model object
- Optional $inc: T
  
  (optional) incremental set
Returns Promise<T>
- Defined in src/cores/storage/model-manager.ts:141

updateOrCreate

updateOrCreate(id: string, model: T, $inc?: T): Promise<T>
default implementation of 'upserting' model
Parameters
- id: string
  
  model id
- model: T
  
  model object
- Optional $inc: T
  
  (optional) incremental set
Returns Promise<T>
- Defined in src/cores/storage/model-manager.ts:152

Class AbstractManager<T, S, ModelType>Abstract

Abstract

Type Parameters

T extends CoreModel<ModelType>

S extends StorageMakeable<T, ModelType>

ModelType extends string

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

T extends CoreModel<ModelType, T>

S extends StorageMakeable<T, ModelType, S>

ModelType extends string

Parameters

type: ModelType

parent: S

fields: string[]

Optional uniqueField: string

Optional ns: string

Returns AbstractManager<T, S, ModelType>

Properties

Readonly $unique

Readonly FIELDS

Readonly NS

Readonly parent

Readonly storage

Accessors

type

Returns ModelType

Methods

Private _updateModel

Parameters

id: string

model: T

Optional $inc: T

isCreate: boolean = true

Returns Promise<T>

afterRead

Parameters

model: T

Optional origin: T

Returns T

afterSave

Parameters

model: T

Optional origin: T

Returns T

afterUpdate

Parameters

model: T

Returns T

beforeSave

Parameters

model: T

Optional origin: T

Returns T

beforeUpdate

Parameters

model: T

Optional incrementals: T

Returns T

delete

Parameters

id: string

destroy: boolean = true

Returns Promise<T>

hello

Returns string

insert

Parameters

model: T

Returns Promise<T>

onBeforeSave

Parameters

model: T

Class AbstractManager<T, S, ModelType>`Abstract`

`Protected` constructor

`Optional` uniqueField: string

`Optional` ns: string

`Readonly` $unique

`Readonly` FIELDS

`Readonly` NS

`Readonly` parent

`Readonly` storage

`Private` _updateModel

`Optional` $inc: T

`Optional` origin: T

`Optional` origin: T

`Optional` origin: T

`Optional` incrementals: T

`Optional` origin: T

`Optional` $def: T

`Protected` `Abstract` prepareDefault

`Optional` $inc: T

`Optional` $inc: T