Skip to main content

SimpleAllowedTypeAttributes Interface

Information about allowed types under a field. \

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.

Sealed

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 SimpleAllowedTypeAttributes

Properties

Property Alerts Modifiers Type Description
isStaged Alpha readonly boolean | undefined

True if this schema is included as a staged schema upgrade, allowing the view schema be compatible with stored schema with (post upgrade) or without it (pre-upgrade). New documents and schema upgrades will omit any staged schema.

Undefined if derived from a stored schema.

Property Details

isStaged

True if this schema is included as a staged schema upgrade, allowing the view schema be compatible with stored schema with (post upgrade) or without it (pre-upgrade). New documents and schema upgrades will omit any staged schema.

Undefined if derived from a stored schema.

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 isStaged: boolean | undefined;

Type: boolean | undefined