Skip to content

Commit eb04728

Browse files
jatgargJatin Garg
andauthored
Changeset fixes before release. (microsoft#26255)
Changeset fixes before release. Fixing formatting for the changesets. Co-authored-by: Jatin Garg <jatingarg@Jatins-MacBook-Pro-2.local>
1 parent dc1c691 commit eb04728

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

.changeset/happy-pens-clap.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
"@fluid-example/text-editor": minor
3+
"__section": tree
34
---
45

56
New text-editor example demonstrating SharedTree with Quill

.changeset/heavy-canyons-change.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@
77
The `getRevertible` factory provided by the `changed` event is now exposed on the `ChangeMetadata` object instead of as
88
the second callback parameter. The second parameter is deprecated and will be removed in a future release.
99

10-
## Why this change?
10+
#### Why this change?
1111

1212
Keeping all per-change data on `ChangeMetadata` makes the API:
1313

14-
1. Easier to discover
15-
1. Easier to ignore
16-
1. Require less parameter churn to use
14+
1. Easier to discover.
15+
1. Easier to ignore.
16+
1. Require less parameter churn to use.
1717
1. Consistent with the `getChange` API, which is also only available on local commits.
1818

19-
## Migration
19+
#### Migration
2020

2121
**Before (deprecated):**
2222

.changeset/lemon-deer-walk.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
"@fluidframework/tree-agent": minor
3+
"__section": tree
34
---
45

56
tree-agent: New type factory system for method and property bindings
@@ -8,14 +9,14 @@ The `@fluidframework/tree-agent` package now includes a custom type system (Type
89
defining method and property types. This new system is available in the `/alpha` entry point and provides a familiar
910
API for type definitions.
1011

11-
## Key features
12+
#### Key features
1213

1314
- **Familiar API**: Use `tf.string()`, `tf.object()`, etc. - similar to Zod's syntax (where `tf` is aliased from
1415
`typeFactory`)
1516
- **Same API surface**: The existing `expose`, `exposeProperty`, and `buildFunc` methods work with both Zod and Type
1617
Factory types
1718

18-
## Usage
19+
#### Usage
1920

2021
Import from the alpha entry point to use Type Factory types:
2122

@@ -42,7 +43,7 @@ class TodoList extends sf.object("TodoList", {
4243
}
4344
```
4445

45-
## Available types
46+
#### Available types
4647

4748
All common types are supported:
4849

@@ -53,7 +54,7 @@ All common types are supported:
5354
- **Utilities**: `tf.union([types])`, `tf.literal(value)`, `tf.optional(type)`, `tf.readonly(type)`
5455
- **Schema references**: `tf.instanceOf(SchemaClass)`
5556

56-
## Migration from Zod
57+
#### Migration from Zod
5758

5859
You can migrate gradually - both Zod and Type Factory types work in the same codebase:
5960

@@ -82,7 +83,7 @@ methods.expose(
8283
);
8384
```
8485

85-
## Note on type safety
86+
#### Note on type safety
8687

8788
The Type Factory type system does not currently provide compile-time type checking, though this may be added in the
8889
future. For applications requiring strict compile-time validation, Zod types remain fully supported.

0 commit comments

Comments
 (0)