SimpleNodeSchemaBaseAlpha Interface

A SimpleNodeSchema containing fields for alpha features.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface SimpleNodeSchemaBaseAlpha<out Type extends SchemaType, out TNodeKind extends NodeKind, out TCustomMetadata = unknown> extends SimpleNodeSchemaBase<TNodeKind, TCustomMetadata>

Extends: SimpleNodeSchemaBase<TNodeKind, TCustomMetadata>

Type Parameters

Parameter	Constraint	Default	Description
Type	SchemaType
TNodeKind	NodeKind
TCustomMetadata		unknown

Properties

Property	Alerts	Modifiers	Type	Description
metadata	Alpha	readonly	SimpleNodeSchemaBase<TNodeKind, TCustomMetadata>["metadata"] & (Type extends SchemaType.View ? unknown : { readonly custom?: undefined; readonly description?: undefined; })
persistedMetadata	Alpha	readonly	JsonCompatibleReadOnlyObject | undefined	Persisted metadata for this node schema.

Property Details

metadata

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

For more information about our API support guarantees, see here.

Signature

readonly metadata: SimpleNodeSchemaBase<TNodeKind, TCustomMetadata>["metadata"] & (Type extends SchemaType.View ? unknown : {
        readonly custom?: undefined;
        readonly description?: undefined;
    });

Type: SimpleNodeSchemaBase<TNodeKind, TCustomMetadata>["metadata"] & (Type extends SchemaType.View ? unknown : { readonly custom?: undefined; readonly description?: undefined; })

persistedMetadata

Persisted metadata for this node schema.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

For more information about our API support guarantees, see here.

Signature

readonly persistedMetadata: JsonCompatibleReadOnlyObject | undefined;

Type: JsonCompatibleReadOnlyObject | undefined

Remarks

While this can be stored in the document, not all versions / configurations will do so. Additionally, this is not part of schema compatibility, so different clients (even within the same collaborative session) may see different persistedMetadata for the same node. Specified using persistedMetadata.