Interface ClusterElement

A cluster describes a set of related functionality.

interface ClusterElement {
    constructor: any;
    asOf?: `${number}.${number}`;
    children?: Child[];
    classification?: "endpoint" | "node" | "application";
    description?: string;
    details?: string;
    id?: number;
    isGlobal?: boolean;
    isSeed?: boolean;
    name: string;
    pics?: string;
    quality?: Definition;
    tag: "cluster";
    type?: string;
    until?: `${number}.${number}`;
    xref?: Specification.CrossReference;
}

Hierarchy (view full)

Implemented by

Constructors

constructor

Properties

asOf? children? classification? description? details? id? isGlobal? isSeed? name pics? quality? tag type? until? xref?

Constructors

constructor

constructor: any

Properties

OptionalasOf

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

The first Matter specification in which this element appears.

Optionalchildren

children?: Child[]

Child elements.

Optionalclassification

classification?: "endpoint" | "node" | "application"

Encodes both classification and scope from the Matter specification.

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.

Optionalpics

pics?: string

The cluster's PICS code.

Optionalquality

quality?: Definition

Other qualities.

Quality flags allowed for clusters are "I" (singleton) and "K" (diagnostics). The spec as of 1.3 does not appear to use the singleton flag, however.

tag

tag

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