[I] ModelProperty
A named model field, including copied fields introduced by composition.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Modifier | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|---|
creating? | public | true | If the type is currently being created. | - | BaseType.creating |
decorators | public | DecoratorApplication[] | Applications used when finishing this type, including copied or synthesized applications. | - | DecoratedType.decorators |
defaultValue? | public | Value | Checked default value, when a default was supplied. | - | - |
entityKind | readonly | "Type" | Distinguishes semantic types from values and parameter constraints. | - | BaseType.entityKind |
instantiationParameters? | public | Type[] | Legacy instantiation metadata. The compiler’s type checker does not populate this field, so its absence does not indicate whether this type is a template instance. | - | BaseType.instantiationParameters |
isFinished | public | boolean | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | BaseType.isFinished |
kind | public | "ModelProperty" | Discriminant for model fields and operation parameters. | BaseType.kind | - |
model? | public | Model | Containing model, when attached; copied properties belong to the receiving model. | - | - |
name | public | string | Key under which this property appears in its containing model. | - | - |
node? | public | | ModelPropertyNode | ModelSpreadPropertyNode | ObjectLiteralPropertyNode | Node used to construct this type. If the node is undefined it means the type was dynamically built. With typekit for example. | BaseType.node | - |
optional | public | boolean | Whether the property may be omitted; this does not add null to its type. | - | - |
sourceProperty? | public | ModelProperty | Property copied to create this one through composition, when applicable. | - | - |
type | public | Type | Type of values accepted by the property, independent of optionality. | - | - |