Class GeneralModelFilter<T, ModelType>

class: GeneralModelFilter

general model-filter with differential update.
to customize, override this class.

Type Parameters

T extends CoreModel<ModelType>
ModelType extends string

Hierarchy

GeneralModelFilter
- AbstractManager

Implements

CoreModelFilterable<T>

Index

Constructors

Properties

Methods

afterRead afterSave afterUpdate beforeSave beforeUpdate onBeforeSave

Constructors

constructor

new GeneralModelFilter<T, ModelType>(fields: string[]): GeneralModelFilter<T, ModelType>
default constructor
Type Parameters
- T extends CoreModel<ModelType, T>
- ModelType extends string
Parameters
- fields: string[]
Returns GeneralModelFilter<T, ModelType>
- Defined in src/cores/storage/proxy-storage-service.ts:134

Properties

`Readonly` FIELDS

FIELDS: string[]

Methods

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
Implementation of CoreModelFilterable.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
Implementation of CoreModelFilterable.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
Implementation of CoreModelFilterable.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
Implementation of CoreModelFilterable.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
Implementation of CoreModelFilterable.beforeUpdate
- Defined in src/cores/storage/proxy-storage-service.ts:248

onBeforeSave

onBeforeSave(model: T, origin?: T): T
override this onBeforeSave() in sub-class.
Parameters
- model: T
  
  the current model
- Optional origin: T
  
  (optional) the origin model
Returns T
- Defined in src/cores/storage/proxy-storage-service.ts:266

Generated using TypeDoc