OptionalasThe first Matter specification in which this element appears.
OptionalbyteApplies to numeric types.
OptionaldefaultThe default value for the element.
OptionaldescriptionA short summary of the element.
OptionaldetailsA paragraph summary of the element.
OptionalerrorsOptionalidFields must have IDs but they may be implied by the field's position in its parent.
OptionalisIs this a "seed" element? These are global types and cluster elements defined in the core specification, without which we are fairly incapacitated.
OptionalisIndicates that an element defines a datatype.
OptionalisIndicates that an element may have type definitions as children.
OptionalmetatypeThe key used for storing this element. A "human appropriate" semantic differentiator.
OptionaloperationalOptionaltypeIf an element derives from another element, the name of the parent element goes here.
OptionaluntilThe Matter specification revision in which this element was removed.
OptionalxrefReference to Matter specification document.
StatictypesFactory support. Populated by derivatives upon definition.
Authorization limits.
Authorization limits.
A subset of members with conflicts resolved by conformance.
ValueModels may derive from models of the same type or from generic Datatype models.
ValueModels may only derive from ValueModels.
Children of models are always models.
Children of models are always models.
Optionality control.
Optionality control.
The subset of members that are conformant.
Limits on values.
Limits on values.
Get the first derived ancestor with children, if any.
Obtain a discriminator that differentiates different models with the same name
The value to use as a default. The "default" field has a manually supplied value but this property decodes the default and/or generates a default from subfields.
Fields may omit their ID. In this case we use their index within the parent as the ID.
The "effective type" may be inferred from context.
A local or parent xref.
Active members keyed by property name.
Get the first global base type. This may have semantic meaning more specific than the base primitive type.
Is this model deprecated?
Is this model disallowed?
Determine if this model resides in the global namespace.
The key for bitmap fields is actually the constraint which defines the bit range. All other datatypes use the default key.
Get the entry type for lists, if any.
Is the model mandatory?
All FieldModel children}.
Metatype is only present on global types with specific semantic meaning. This model is significant because it gives us information about how to manipulate the data. This accessor retrieves this model.
Can this model be omitted?
Determine whether this element overrides key properties of its shadow.
The structural parent. This is the model for the element that contains this element's definition.
The path ("." delimited) in the Matter tree.
This is informational and generally tries to adhere to JS API conventions.
Get the primitive type for this value model. This is an integer type for enums and bitmaps. Otherwise it's the metabase.
Other qualities not covered by conformance or access.
Other qualities not covered by conformance or access.
Get shadow model, if any. A "shadow" is an element in my parent's inheritance hierarchy that I override.
Did validation find errors?
Search the inheritance chain for a bitmap field defining a specific bit.
Create an operational extension of the model. This creates a new model that inherits from this model for operational purposes.
Optionalproperties: Partial<Properties<T>>Freeze the model hierarchy rooted at this model.
When using a model as operational schema we implement various optimizations that assume the schema is immutable. This function enforces that assumption.
To make changes to a frozen model use clone.
Retrieve a specific child by ID or name.
Does this model derive from another?
Search the inheritance chain for a child property.
Retrieve a model of a specific type from the ownership hierarchy.
Find all children that reference a specific type.
Apply a function to all tree elements.
StaticcreateCreate a model for an element.
A field element defines a field in a list, struct, enum or bitmap.