An object describing an entity type.
Syntax
Types.typeName
Database.types.typeName
repository.type
query.type
entity.$type
Properties
Property | Type | Description |
---|---|---|
[name] | string | The entity type name. |
[description] | string | The entity type description. |
[descriptionSingular] | string | The entity type description in singular form. See Remarks below. |
[idField] | string | The name of the entity id field. |
[descriptionField] | string | The name of the entity description field. |
properties | object | A enumerable object contains the entity properties. It includes fields, aliases, expressions, references, collections, etc. |
aliases | object | A enumerable object contains the entity aliases. |
fields | object | A dictionary of objects describing the entity fields. |
[expressions] | object | A enumerable object contains objects describing the entity expressions. |
references | object | A dictionary of objects describing the entity references. |
collections | object | A enumerable object contains objects describing the entity collections. |
[triggers] | object | A enumerable object contains notification trigger descriptions. |
[parent] | object | A reference to the parent type if the object has one. |
Remarks
Each entity type by default has descriptionSingular field constructed from description using English rules for singular forms of words.