JsonNodeSchemaBase Interface
Base interface for node schemas represented in JSON Schema format.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
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 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. |
| description | Alpha |
optional, readonly |
string | undefined | Description of the node schema. |
| type | Alpha |
readonly |
TJsonSchemaType | JSON entity type. |
Property Details
_treeNodeSchemaKind
Kind of TreeNodeSchema this JSON Schema entry represents.
For more information about our API support guarantees, see here.
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
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.
description
Description of the node schema.
For more information about our API support guarantees, see here.
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
readonly description?: string | undefined;
Type: string | undefined
Remarks
Derived from description.
See Also
https://json-schema.org/draft/2020-12/json-schema-validation#name-title-and-description
type
JSON entity type.
For more information about our API support guarantees, see here.
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
readonly type: TJsonSchemaType;
Type: TJsonSchemaType