Class Model

Hierarchy (View Summary)

StrictModel
- Model

Index

Constructors

Properties

Methods

$attach? toJSON toObject? $metadata modelize

Constructors

constructor

new Model(): Model
Returns Model
Inherited from StrictModel.constructor
- Defined in src/core/model.ts:17

Properties

`Optional`_id

_id?: ID

Methods

`Optional`$attach

$attach?<T>(data?: T): Attachment<T>
Type Parameters
- T
Parameters
- Optionaldata: T
Returns Attachment<T>
Inherited from StrictModel.$attach
- Defined in src/core/model.ts:27

toJSON

toJSON(options?: DocumentToObjectOptions): AsObject<this>
Parameters
- options: DocumentToObjectOptions = {}
Returns AsObject<this>
Inherited from StrictModel.toJSON
- Defined in src/core/model.ts:49

`Optional`toObject

toObject?(options?: DocumentToObjectOptions): any
Parameters
- options: DocumentToObjectOptions = {}
Returns any
Inherited from StrictModel.toObject
- Defined in src/core/model.ts:76

`Static`$metadata

$metadata(): Ark7ModelMetadata
Returns Ark7ModelMetadata
Inherited from StrictModel.$metadata
- Defined in src/core/model.ts:23

`Static`modelize

modelize<T extends new (...args: any[]) => any>(
    this: T,
    o: AsObject<InstanceType<T>>,
    options?: ModelizeOptions,
): InstanceType<T>
Type Parameters
- T extends new (...args: any[]) => any
Parameters
- this: T
- o: AsObject<InstanceType<T>>
- options: ModelizeOptions = {}
Returns InstanceType<T>
Inherited from StrictModel.modelize
- Defined in src/core/model.ts:81