Skip to main content

ErasedSchema TypeAlias

The type of an erased schema.

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

export type ErasedSchema<NodeType extends TreeNode> = TreeNodeSchema<NodeType extends WithType<infer Identifier> ? Identifier : string, NodeKind, NodeType, never, false>;

Type Parameters

ParameterConstraintDescription
NodeTypeTreeNode

Remarks

Provides an isolatedDeclarations compatible way to explicitly type the return value from eraseSchemaDetails().

Example

export const Square: SquareSchema & ErasedSchema<Square> = eraseSchemaDetails<Square, SquareSchema>()(SquareInternal);
export type Square = ErasedNode<SquareNode, "com.example.Demo">;