Skip to main content

TypeFactoryObject Interface

Represents an object type with a fixed shape in the type factory system.

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

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

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

Signature

export interface TypeFactoryObject extends TypeFactoryType

Extends: TypeFactoryType

Properties

PropertyAlertsModifiersTypeDescription
_kindAlphareadonly"object"The kind of type this represents.
shapeAlphareadonlyRecord<string, TypeFactoryType>The shape of the object, mapping property names to their types.

Property Details

_kind

The kind of type this represents.

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

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

Signature

readonly _kind: "object";

Type: "object"

shape

The shape of the object, mapping property names to their types.

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

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

Signature

readonly shape: Record<string, TypeFactoryType>;

Type: Record<string, TypeFactoryType>