Skip to content

Commit b9456a3

Browse files
committed
update release notes
1 parent 5ca171e commit b9456a3

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

client/release/RELEASE-NOTES

+26-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@
1111

1212
- **Deleting Archived Items:** The SDK now supports deleting items from the archive.
1313

14-
## IMPROVED
15-
16-
* The return type of the listing functions has changed from `SdkIterable<T>` to `T[]`.
17-
1814
### ⚠️ BREAKING CHANGES ⚠️
1915
This release contains breaking changes for two functions in the JS SDK.
2016

@@ -29,6 +25,19 @@ with:
2925
const vaults = await client.vaults.list();
3026
```
3127

28+
* The return type of the vault listing functions has changed from `SdkIterable<VaultOverview>` to `VaultOverview[]`. To use this in your code, replace:
29+
```js
30+
for await (const vault of vaults) {
31+
console.log(vault.id + " " + vault.title);
32+
}
33+
```
34+
with:
35+
```js
36+
for (const vault of vaults) {
37+
console.log(vault.id + " " + vault.title);
38+
}
39+
```
40+
3241
**Item listing**
3342

3443
* The function name has changed from `listAll` to `list`. To use this in your code, replace:
@@ -43,4 +52,17 @@ const overviews = await client.items.list(vault.id, {
4352
})
4453
```
4554

55+
* The return type of the item listing functions has changed from `SdkIterable<ItemOverview>` to `ItemOverview[]`. To use this in your code, replace:
56+
```js
57+
for await (const overview of overviews) {
58+
console.log(overview.id + " " + overview.title);
59+
}
60+
```
61+
with:
62+
```js
63+
for (const overview of overviews) {
64+
console.log(overview.id + " " + overview.title);
65+
}
66+
```
67+
4668
This does not affect any code that's already deployed, and will not take effect in your codebase until you choose to update to version 0.3.0 or later of the 1Password JS SDK.

0 commit comments

Comments
 (0)