Interface DatatypeElement

A datatype represents a named, standalone type definition.

interface DatatypeElement {
    constructor: any;
    access?: Definition;
    asOf?: `${number}.${number}`;
    byteSize?: ByteSize;
    children?: FieldElement[];
    conformance?: Definition;
    constraint?: Definition;
    default?: FieldValue;
    description?: string;
    details?: string;
    id?: undefined;
    isGlobal?: boolean;
    isSeed?: boolean;
    metatype?:
        | "string"
        | "boolean"
        | "object"
        | "bytes"
        | "any"
        | "bitmap"
        | "enum"
        | "integer"
        | "float"
        | "array"
        | "date";
    name: string;
    quality?: Definition;
    tag: "datatype";
    type?: string;
    until?: `${number}.${number}`;
    xref?: Specification.CrossReference;
}

Hierarchy (view full)

Implemented by

Constructors

constructor

Properties

access? asOf? byteSize? children? conformance? constraint? default? description? details? id? isGlobal? isSeed? metatype? name quality? tag type? until? xref?

Constructors

constructor

constructor: any

Properties

Optionalaccess

access?: Definition

Authorization limits.

OptionalasOf

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

The first Matter specification in which this element appears.

OptionalbyteSize

byteSize?: ByteSize

Applies to numeric types.

Optionalchildren

children?: FieldElement[]

Child elements.

Optionalconformance

conformance?: Definition

Optionality control.

Optionalconstraint

constraint?: Definition

Limits on values.

Optionaldefault

default?: FieldValue

The default value for the element.

Optionaldescription

description?: string

A short summary of the element.

Optionaldetails

details?: string

A paragraph summary of the element.

Optionalid

id?: undefined

You can only reference a datatype by name. It does not have an ID.

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.

Optionalmetatype

metatype?:
    | "string"
    | "boolean"
    | "object"
    | "bytes"
    | "any"
    | "bitmap"
    | "enum"
    | "integer"
    | "float"
    | "array"
    | "date"

A "metatype" provides enough semantics for us to translate a value into a native datatype. Metatype is only required on global datatypes, and only when the datatype should map directly to a specific native (JS) type.

name

name: string

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

Optionalquality

quality?: Definition

Other qualities not covered by conformance or access.

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