Interface Features<F>

Cluster "features" describe the features supported by a cluster.

interface Features<F> {
    base?: ClusterType;
    extensions?: readonly Extension<F>[];
    features: F;
    supportedFeatures: TypeFromPartialBitSchema<F>;
    unknown: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

base? extensions? features supportedFeatures unknown

Properties

Optional Readonlybase

base?: ClusterType

If you enable features, this property tracks the shape of the cluster with no features enabled.

Optional Readonlyextensions

extensions?: readonly Extension<F>[]

Metadata controlling how enabled features affect cluster structure.

Readonlyfeatures

features: F

Features the cluster may support.

ReadonlysupportedFeatures

supportedFeatures: TypeFromPartialBitSchema<F>

Features the cluster does support.

Readonlyunknown

unknown: boolean

If true, this flag indicates that the cluster is not known to matter.js. This implies a cluster ID for which we do not have a cluster definition.

Some functionality is available for unknown clusters but an official Matter definition is generally required for full functionality.

Settings

Member Visibility

On This Page

Properties