Interface BaseElement

Per the Matter specification, an element is a data construct that supports an instance of data. So, a class.

Elements as defined by this package are a static data structure. Each element has a corresponding "Model" that is a proper class with runtime functionality related to the element.

interface BaseElement {
    constructor: any;
    asOf?: `${number}.${number}`;
    children?: BaseElement[];
    description?: string;
    details?: string;
    id?: number;
    isGlobal?: boolean;
    isSeed?: boolean;
    name: string;
    type?: string;
    until?: `${number}.${number}`;
    xref?: Specification.CrossReference;
}

Hierarchy (view full)

Constructors

constructor

Properties

asOf? children? description? details? id? isGlobal? isSeed? name type? until? xref?

Constructors

constructor

constructor: any

Properties

OptionalasOf

asOf?: `${number}.${number}`

The first Matter specification in which this element appears.

Optionalchildren

children?: BaseElement[]

Child elements.

Optionaldescription

description?: string

A short summary of the element.

Optionaldetails

details?: string

A paragraph summary of the element.

Optionalid

id?: number

The ID of the element per Matter specification, either global or context-specific. A "machine appropriate" semantic differentiator.

OptionalisGlobal

isGlobal?: boolean

Is this a global element? Global elements are available in-scope for every cluster.

OptionalisSeed

isSeed?: boolean

Is this a "seed" element? These are global types and cluster elements defined in the core specification, without which we are fairly incapacitated.

name

name: string

The key used for storing this element. A "human appropriate" semantic differentiator.

Optionaltype

type?: string

If an element derives from another element, the name of the parent element goes here.

Optionaluntil

until?: `${number}.${number}`

The Matter specification revision in which this element was removed.

Optionalxref

xref?: Specification.CrossReference

Reference to Matter specification document.

Settings

Member Visibility

On This Page

Constructors
Properties