FormatVersion TypeAlias

A version stamp for encoded data.

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 FormatVersion = number | string | undefined;

Remarks

Strings are used for formats that are not yet officially supported. When such formats become officially supported/stable, they will be switched to using a number. Undefined is tolerated to enable the scenario where data was not initially versioned.