StagedSchemaUpgradePolicy Interface
Policy controlling which staged schema upgrades are included when generating stored schema from a view schema.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
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
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. |
Method Details
includeStaged
Determines whether to include staged allowed types in the resulting stored schema.
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.
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