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
Enhance documentation with migration guide for version 1.0, update breaking changes section, and adjust category positions for guides and product notes.
Copy file name to clipboardExpand all lines: docs/Guides/Migration/v1.md
+25-33Lines changed: 25 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ id: migration-guide-v1
3
3
sidebar_position: 1
4
4
---
5
5
6
-
# Migration Guide: Version 1.0
6
+
# Version 1.0
7
7
8
8
> Description — _Quick reference for all API changes in cbl-reactnative version 1.0_
9
9
> Related Content — [Release Notes](../../ProductNotes/release-notes.md) | [Using Logs](../../Troubleshooting/using-logs.md)
@@ -16,6 +16,29 @@ Version 1.0 introduces several API changes:
16
16
3.**New ReplicatorConfiguration** - Collections passed in constructor
17
17
:::
18
18
19
+
## Breaking Changes
20
+
21
+
### Listener Token Return Type (TypeScript)
22
+
23
+
We changed all `addChangeListener` functions to return a `ListenerToken` instead of a `string`, enabling the new `token.remove()` API and aligning with other platforms.
24
+
25
+
This is a breaking change **only for TypeScript code** that explicitly typed the token as `string`. JavaScript users and untyped TypeScript won't be affected.
@@ -93,27 +116,6 @@ This method is deprecated. It remains available for backward compatibility, but
93
116
94
117
---
95
118
96
-
### 4. Listener Token Return Type (TypeScript)
97
-
98
-
We changed all `addChangeListener` functions to return a `ListenerToken` instead of a `string`, enabling the new `token.remove()` API and aligning with other platforms.
99
-
100
-
This is a small breaking change **only for TypeScript code** that explicitly typed the token as `string`. JavaScript users and untyped TypeScript won't be affected.
0 commit comments