StagedSchemaUpgradePolicy Interface

Policy controlling which staged schema upgrades are included when generating stored schema from a view schema.

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.

Input

This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.

Signature

export interface StagedSchemaUpgradePolicy

Properties

Property	Alerts	Modifiers	Default Value	Type	Description
includeAlreadyEnabledUpgrades	Alpha	optional, readonly	true	boolean	Whether schema upgrades should include staged upgrades that are already enabled in the document's stored schema.

Methods

Method	Alerts	Return Type	Description
includeStaged(upgrade)	Alpha	boolean	Determines whether to include staged allowed types in the resulting stored schema.
includeStagedOptional(upgrade)	Alpha	boolean	Determines whether to treat a staged optional field as optional (rather than required) in the resulting stored schema.

Property Details

includeAlreadyEnabledUpgrades

Whether schema upgrades should include staged upgrades that are already enabled in the document's 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 includeAlreadyEnabledUpgrades?: boolean;

Type: boolean

Method Details

includeStaged

Determines whether to include staged allowed types in the resulting 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

includeStaged(upgrade: SchemaUpgrade): boolean;

Remarks

Due to caching, the behavior of this function must be pure.

Parameters

Parameter	Type	Description
upgrade	SchemaUpgrade

Returns

Return type: boolean

includeStagedOptional

Determines whether to treat a staged optional field as optional (rather than required) in the resulting 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

includeStagedOptional(upgrade: SchemaUpgrade): boolean;

Remarks

Due to caching, the behavior of this function must be pure.

Parameters

Parameter	Type	Description
upgrade	SchemaUpgrade

Returns

Return type: boolean