DocumentSchemaValueType TypeAlias

Descripe allowed type for properties in document schema. Please note that for all property types we should use undefined to indicate that particular capability is off. Using false, or some string value (like "off") will result in clients who do not understand that property failing, whereas we want them to continue to collaborate alongside clients who support that capability, but such capability is shipping dark for now.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

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

Signature

export type DocumentSchemaValueType = string | string[] | true | number | undefined;