Class DocumentLikeModel

DataModel to mimic basic document-like behaviour.

Calls () on initialization and on reset()

Also handles _id nicely.

Hierarchy (View Summary)

PreparedModel
- DocumentLikeModel

Index

Constructors

Properties

Accessors

Methods

_initialize _safePrepareData prepareData defineSchema

Constructors

constructor

new DocumentLikeModel(): DocumentLikeModel
Returns DocumentLikeModel
Inherited from PreparedModel.constructor

Properties

_id

_id: string

Pseudo-document ID

Only used for data storage.

`Optional`name

name?: string

Name

Accessors

id

get id(): string
Internal ID

Returns string
- Defined in module/models/abstract/document-like-model.mjs:31

Methods

`Protected`_initialize

_initialize(options?: object): void
Protected
Parameters
- options: object = {}
  Constructor options
Returns void
Inherited from PreparedModel._initialize
- Defined in module/models/abstract/prepared-model.mjs:12

_safePrepareData

_safePrepareData(): void
Internal
Safely prepare data

Returns void
Inherited from PreparedModel._safePrepareData
- Defined in module/models/abstract/prepared-model.mjs:23

`Protected` `Abstract`prepareData

prepareData(): void
Protected
Prepare data after initialization or reset.

Returns void
Inherited from PreparedModel.prepareData
- Defined in module/models/abstract/prepared-model.mjs:37

`Static`defineSchema

defineSchema(options: any): { _id: IDField; name: any }
Parameters
- options: any
Returns { _id: IDField; name: any }
- Defined in module/models/abstract/document-like-model.mjs:13