Class UniqueFieldManager<T, ModelType>

class: UniqueFieldManager

support .{field} is unique in typed-storage-service.
make lookup data entry to save the reverse mapping to origin id.
set .stereo as '#' to mark as lookup. (to filter out from Elastic.search())
set .id as #{field}/{name} or #{name}.
set .meta as origin id.

Type Parameters

T extends CoreModel<ModelType>
ModelType extends string

Hierarchy

UniqueFieldManager

Index

Constructors

Properties

field storage type

Methods

asLookupId findOrCreate hello updateLookup validate

Constructors

constructor

new UniqueFieldManager<T, ModelType>(storage: TypedStorageService<T, ModelType>, field?: string): UniqueFieldManager<T, ModelType>
Type Parameters
- T extends CoreModel<ModelType, T>
- ModelType extends string
Parameters
- storage: TypedStorageService<T, ModelType>
- field: string = 'name'
Returns UniqueFieldManager<T, ModelType>
- Defined in src/cores/storage/proxy-storage-service.ts:935

Properties

`Readonly` field

field: string

`Readonly` storage

storage: TypedStorageService<T, ModelType>

`Readonly` type

type: ModelType

Methods

asLookupId

asLookupId(value: string): string
convert to internal id by value
Parameters
- value: string
  
  unique value in same type group.
Returns string
- Defined in src/cores/storage/proxy-storage-service.ts:957

findOrCreate

findOrCreate(value: string, $creates?: T): Promise<T>
lookup model by value
- use .meta property to link with the origin.
- mark .stereo as to '#' to distinguish normal.
Parameters
- value: string
  
  unique value in same type group.
- Optional $creates: T
  
  (optional) create-set if not found.
Returns Promise<T>
- Defined in src/cores/storage/proxy-storage-service.ts:969

hello

hello(): string
Returns string
- Defined in src/cores/storage/proxy-storage-service.ts:941

updateLookup

updateLookup(model: T, value?: string): Promise<T>
update lookup table (or create)
Parameters
- model: T
  
  target model
- Optional value: string
  
  (optional) new value of model.
Returns Promise<T>
- Defined in src/cores/storage/proxy-storage-service.ts:1020

validate

validate(value: string): boolean
validate value format
- just check empty string.
Parameters
- value: string
  
  unique value in same type+field.
Returns boolean
- Defined in src/cores/storage/proxy-storage-service.ts:948

Generated using TypeDoc