Skip to main content

JsonNodeSchemaBase Interface

Base interface for node schemas represented in JSON Schema format.

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

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

Signature​

/** @sealed */
export interface JsonNodeSchemaBase<TNodeKind extends NodeKind, TJsonSchemaType extends JsonSchemaType>

Type Parameters​

Parameter Constraint Description
TNodeKind NodeKind
TJsonSchemaType JsonSchemaType

Properties​

Property Alerts Modifiers Type Description
_treeNodeSchemaKind Alpha readonly TNodeKind Kind of TreeNodeSchema this JSON Schema entry represents.
type Alpha readonly TJsonSchemaType JSON entity type.

Property Details​

_treeNodeSchemaKind​

Kind of TreeNodeSchema this JSON Schema entry represents.

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

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

Signature​

readonly _treeNodeSchemaKind: TNodeKind;

Type: TNodeKind

Remarks​

There is not a 1:1 mapping between TreeNodeSchema types and JSON Schema types. This is used to disambiguate the type of TreeNodeSchema this JSON Schema maps to.

Note: This property name is not a part of the JSON Schema spec. This is a Fluid-specific extension.

type​

JSON entity type.

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

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

Signature​

readonly type: TJsonSchemaType;

Type: TJsonSchemaType