Class CoreManager<Model, ModelType, Service>`Abstract`

class: CoreManager

shared core manager for all model

Abstract

Type Parameters

Model extends CoreModel<ModelType>
ModelType extends string
Service extends CoreService<Model, ModelType>

Hierarchy

AbstractManager<Model, Service, ModelType>
- CoreManager

Index

Constructors

`Protected` constructor

new CoreManager<Model, ModelType, Service>(type: ModelType, parent: Service, fields: string[], uniqueField?: string): CoreManager<Model, ModelType, Service>
Protected
constructor
Type Parameters
- Model extends CoreModel<ModelType, Model>
- ModelType extends string
- Service extends CoreService<Model, ModelType, Service>
Parameters
- type: ModelType
- parent: Service
- fields: string[]
- Optional uniqueField: string
Returns CoreManager<Model, ModelType, Service>
Overrides AbstractManager.constructor
- Defined in src/extended/abstract-service.ts:178

Properties

`Readonly` $unique

$unique: UniqueFieldManager<Model, ModelType>

`Readonly` FIELDS

FIELDS: string[]

`Readonly` NS

NS: string

`Readonly` parent

parent: Service

`Readonly` storage

storage: TypedStorageService<Model, ModelType>

Accessors

type

get type(): ModelType
type getter

Returns ModelType
Inherited from AbstractManager.type
- Defined in src/cores/storage/model-manager.ts:58

Methods

afterRead

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

afterSave

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

afterUpdate

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

beforeSave

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

beforeUpdate

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

delete

delete(id: string, destroy?: boolean): Promise<Model>
delete model
- override 'AbstractManager.delete()'
Parameters
- id: string
- Optional destroy: boolean
Returns Promise<Model>
Overrides AbstractManager.delete
- Defined in src/extended/abstract-service.ts:349

exists

exists(id: string): Promise<boolean>
get existence of model
Parameters
- id: string
Returns Promise<boolean>
- Defined in src/extended/abstract-service.ts:191

find

find(id: string): Promise<Model>
find model - retrieve or null
Parameters
- id: string
  
  model-id
Returns Promise<Model>
- Defined in src/extended/abstract-service.ts:199

findByKey

findByKey(key: string): Promise<Model>
get model by key
Parameters
- key: string
  
  global id(like primary-key)
Returns Promise<Model>
- Defined in src/extended/abstract-service.ts:210

findByUniqueField

findByUniqueField(uniqueValue: string): Promise<Model>
find model by unique field value - retrieve or null
Parameters
- uniqueValue: string
Returns Promise<Model>
- Defined in src/extended/abstract-service.ts:265

getByUniqueField

getByUniqueField(uniqueValue: string): Promise<Model>
get by unique field value
Parameters
- uniqueValue: string
Returns Promise<Model>
- Defined in src/extended/abstract-service.ts:257

getMulti

getMulti(idList: string[], parrallel?: number): Promise<Model[]>
batch get models
- retrieve multi models per each id
- must be matched with idList in sequence order.
Parameters
- idList: string[]
  
  list of id
- Optional parrallel: number
  
  (optional) in parrallel size
Returns Promise<Model[]>
- Defined in src/extended/abstract-service.ts:225

getMulti$

getMulti$(idList: string[], idName?: string, parrallel?: number): Promise<{ [id: string]: Model }>
batch get models in map by idName
Parameters
- idList: string[]
- idName: string = 'id'
- Optional parrallel: number
Returns Promise<{ [id: string]: Model }>
- Defined in src/extended/abstract-service.ts:233

hello

hello(): string
say hello()

Returns string
Overrides AbstractManager.hello
- Defined in src/extended/abstract-service.ts:185

insert

insert(model: Model, initSeq?: number): Promise<Model>
update model
- override 'AbstractManager.insert()'
Deprecated
use AbstractProxy
Parameters
- model: Model
- Optional initSeq: number
Returns Promise<Model>
Overrides AbstractManager.insert
- Defined in src/extended/abstract-service.ts:294

onBeforeSave

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

prepare

prepare(id: string, $def?: Model, isCreate?: boolean): Promise<Model>
prepare model
- override AbstractManager.prepare()
Parameters
- id: string
- Optional $def: Model
- isCreate: boolean = true
Returns Promise<Model>
Overrides AbstractManager.prepare
- Defined in src/extended/abstract-service.ts:276

`Protected` prepareDefault

prepareDefault($def: Model): Model
prepare default-model when creation
Parameters
- $def: Model
  
  base-model
Returns Model
Overrides AbstractManager.prepareDefault
- Defined in src/extended/abstract-service.ts:365

retrieve

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

save

save(id: string, model: Model): Promise<Model>
create or update model
Parameters
- id: string
  
  model id
- model: Model
  
  model data
Returns Promise<Model>
- Defined in src/extended/abstract-service.ts:304

update

update(id: string, model: Model, $inc?: Model): Promise<Model>
update model
- override 'AbstractManager.update()'
Parameters
- id: string
- model: Model
- Optional $inc: Model
Returns Promise<Model>
Overrides AbstractManager.update
- Defined in src/extended/abstract-service.ts:319

`Protected` updateLookup

updateLookup(id: string, model: Model, $org?: Model): Promise<void>
update lookup and delete old one if exists
Parameters
- id: string
- model: Model
- Optional $org: Model
Returns Promise<void>
- Defined in src/extended/abstract-service.ts:372

updateOrCreate

updateOrCreate(id: string, model: Model, $inc?: Model): Promise<Model>
update or create model
- override 'AbstractManager.updateOrCreate()'
Parameters
- id: string
- model: Model
- Optional $inc: Model
Returns Promise<Model>
Overrides AbstractManager.updateOrCreate
- Defined in src/extended/abstract-service.ts:334

Class CoreManager<Model, ModelType, Service>Abstract

Abstract

Type Parameters

Model extends CoreModel<ModelType>

ModelType extends string

Service extends CoreService<Model, ModelType>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

Model extends CoreModel<ModelType, Model>

ModelType extends string

Service extends CoreService<Model, ModelType, Service>

Parameters

type: ModelType

parent: Service

fields: string[]

Optional uniqueField: string

Returns CoreManager<Model, ModelType, Service>

Properties

Readonly $unique

Readonly FIELDS

Readonly NS

Readonly parent

Readonly storage

Accessors

type

Returns ModelType

Methods

afterRead

Parameters

model: Model

Optional origin: Model

Returns Model

afterSave

Parameters

model: Model

Optional origin: Model

Returns Model

afterUpdate

Parameters

model: Model

Returns Model

beforeSave

Parameters

model: Model

Optional origin: Model

Returns Model

beforeUpdate

Parameters

model: Model

Optional incrementals: Model

Returns Model

delete

Parameters

id: string

Optional destroy: boolean

Returns Promise<Model>

exists

Parameters

id: string

Returns Promise<boolean>

find

Parameters

id: string

Returns Promise<Model>

findByKey

Parameters

key: string

Returns Promise<Model>

findByUniqueField

Parameters

uniqueValue: string

Returns Promise<Model>

getByUniqueField

Class CoreManager<Model, ModelType, Service>`Abstract`

`Protected` constructor

`Optional` uniqueField: string

`Readonly` $unique

`Readonly` FIELDS

`Readonly` NS

`Readonly` parent

`Readonly` storage

`Optional` origin: Model

`Optional` origin: Model

`Optional` origin: Model

`Optional` incrementals: Model

`Optional` destroy: boolean

`Optional` parrallel: number

`Optional` parrallel: number

`Optional` initSeq: number

`Optional` origin: Model

`Optional` $def: Model

`Protected` prepareDefault

`Optional` $inc: Model

`Protected` updateLookup

`Optional` $org: Model

`Optional` $inc: Model