Skip to main content

RecordNodeSchema TypeAlias

A schema for TreeRecordNodes.

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

To use, import via @fluidframework/tree/alpha.

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

Signature

export type RecordNodeSchema<TName extends string = string, T extends ImplicitAnnotatedAllowedTypes = ImplicitAnnotatedAllowedTypes, ImplicitlyConstructable extends boolean = true, TCustomMetadata = unknown> = RecordNodeCustomizableSchema<TName, T, ImplicitlyConstructable, TCustomMetadata> | RecordNodePojoEmulationSchema<TName, T, ImplicitlyConstructable, TCustomMetadata>;

Type Parameters

Parameter Constraint Default Description
TName string string
T ImplicitAnnotatedAllowedTypes ImplicitAnnotatedAllowedTypes
ImplicitlyConstructable boolean true
TCustomMetadata unknown