You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Expose staged, types, stagedRecursive and typesRecursive on `… (microsoft#25779)
## Description
This PR promotes SchemaStaticsAlpha to SchemaStaticsBeta, and exposes
`staged`, `types`, `stagedRecursive` and `typesRecursive` to be used in
beta apps.
---------
Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/docs/data-structures/tree/schema-evolution/allowed-types-rollout.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ synchronizeTrees();
32
32
33
33
### Step 1: Define and Stage the New Allowed Type
34
34
35
-
To add support for reading strings, we import the alpha APIs and use [`staged`](../../../api/fluid-framework/schemafactoryalpha-class#staged-property) to mark the new allowed type:
35
+
To add support for reading strings, we import the alpha APIs and use [`staged`](../../../api/fluid-framework/schemafactorybeta-class.md) to mark the new allowed type:
36
36
37
37
```typescript
38
38
// Schema B: number or string (string is staged)
@@ -63,7 +63,7 @@ assert.throws(() => {
63
63
});
64
64
```
65
65
66
-
For this schema change, the schema does not need to be [upgraded](./index.mdx#schema-upgrade-process) because [`staged`](../../../api/fluid-framework/schemafactoryalpha-class#staged-property) allowed types are removed from stored schemas.
66
+
For this schema change, the schema does not need to be [upgraded](./index.mdx#schema-upgrade-process) because [`staged`](../../../api/fluid-framework/schemafactorybeta-class.md) allowed types are removed from stored schemas.
67
67
Upgrading the schema would result in a noop.
68
68
69
69
### Step 3: Wait for Client Saturation
@@ -75,7 +75,7 @@ See the [staged rollouts](./index.mdx#staged-rollouts) section for more details
75
75
76
76
### Step 4: Upgrade to Allow Inserting the New Allowed Type
77
77
78
-
Once client saturation has been reached, remove the [`staged()`](../../../api/fluid-framework/schemafactoryalpha-class#staged-property) wrapper from the new allowed type and call `upgradeSchema` to make a change to the stored schema:
78
+
Once client saturation has been reached, remove the [`staged()`](../../../api/fluid-framework/schemafactorybeta-class.md) wrapper from the new allowed type and call `upgradeSchema` to make a change to the stored schema:
79
79
80
80
```typescript
81
81
// Schema C: number or string, both fully allowed
@@ -101,6 +101,6 @@ Any client code changes to add functionality for inserting the new allowed type
101
101
102
102
## See Also
103
103
104
-
-[`SchemaStaticsAlpha.staged()` API](../../../api/fluid-framework/schemafactoryalpha-class#staged-property) - API documentation
104
+
-[`SchemaStaticsBeta.staged()` API](../../../api/fluid-framework/schemafactorybeta-class.md) - API documentation
105
105
-[Schema Definition](../schema-definition.mdx) - How to define schemas
106
106
-[Node Types](../node-types.mdx) - Understanding different node types
0 commit comments