Interface Model<TEntity>

Represents a model. Models are the minimal unit of data.

Type parameters

TEntity: Entity

Hierarchy

BaseModel
- Model

Implemented by

AntModel

Index

Properties

id
keyGen

Methods

Properties

id

id: string

Model's id field.

keyGen

keyGen: KeyGenParams

Key generation config.

Methods

entityToPrimary

entityToPrimary(entity: TEntity): any

- Defined in model/model.ts:13
Transforms an entity into a primary object.

Parameters
- entity: TEntity
  
  Entity to transform
Returns any

mEntityToPrimary

mEntityToPrimary(entities: TEntity[]): any[]

- Defined in model/model.ts:18
Transforms a set of entities into a set of primary objects.

Parameters
- entities: TEntity[]
  
  Entities to transform
Returns any[]

mPrimaryToEntity

mPrimaryToEntity(primaries: any[]): TEntity[]

- Defined in model/model.ts:23
Transform a set of primary objects into a set of entities

Parameters
- primaries: any[]
  
  Primaries to transform
Returns TEntity[]

primaryToEntity

primaryToEntity(primary: any): TEntity

- Defined in model/model.ts:28
Transform a primary object into an entity.

Parameters
- primary: any
  
  Primary object to transform.
Returns TEntity

Generated using TypeDoc