ModelMetadata

@webda/compiler

---

Interface: ModelMetadata

Defined in: definition.ts:149

Properties

Actions

Actions: object

Defined in: definition.ts:233

Actions defined for the model

Index Signature

[action: string]: object

---

Ancestors

Ancestors: string[]

Defined in: definition.ts:202

Ancestors of the model

Ordered from the closest to the farest CoreModel is ignored

class Test extends Parent extends GrandParent extends CoreModel ["Parent", "GrandParent"]

---

Events

Events: string[]

Defined in: definition.ts:218

Return all events for the model

---

Identifier

Identifier: string

Defined in: definition.ts:153

Model identifier

---

Import

Import: string

Defined in: definition.ts:157

File to import

---

Plural

Plural: string

Defined in: definition.ts:161

Specific plurals for a model

---

PrimaryKey

PrimaryKey: string[]

Defined in: definition.ts:210

Return the primary key

---

PrimaryKeySeparator?

optional PrimaryKeySeparator?: string

Defined in: definition.ts:214

Separator for the primary key to serialize it

---

Reflection

Reflection: object

Defined in: definition.ts:222

Fields reflection

Index Signature

[field: string]: object

---

Relations

Relations: ModelGraph

Defined in: definition.ts:192

Models graph

Typescript does not have reflection, we therefore deduct the relations on compilation time and inject in the module

The parent is define by a ModelParent type on the model The links are attribute of types ModelLink

---

Schemas

Schemas: object

Defined in: definition.ts:165

Schemas defining the model

Input?

optional Input?: JSONSchema7

Schema for input validation

Output?

optional Output?: JSONSchema7

Schema for output validation

Stored?

optional Stored?: JSONSchema7

Schema for stored data validation

---

ShortName?

optional ShortName?: string

Defined in: definition.ts:182

If model have a short name

---

Subclasses

Subclasses: string[]

Defined in: definition.ts:206

Direct Subclasses of the model