From d1a61035f9e4b71e3d75c9eff607de604b85e3fd Mon Sep 17 00:00:00 2001 From: Owen Pearson Date: Tue, 8 Nov 2022 14:36:15 +0000 Subject: [PATCH 1/2] chore: update changelog for 1.2.31 release --- CHANGELOG.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e2985a665b..be22155242 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,24 @@ This contains only the most important and/or user-facing changes; for a full changelog, see the commit history. +## [1.2.31](https://github.com/ably/ably-js/tree/1.2.31) (2022-11-08) + +In the latest release of ably-js, we’ve added jsdoc comments for the public methods and properties provided by the SDK so you can quickly access the descriptions directly in your code editor using Intelligent code completion features like Intellisense in VSCode. + +We have also implemented the fetch API as a fallback HTTP transport so that ably-js is now fully functional in a service worker context. + +**How do I give feedback?** +This docs update and further planned changes are based on feedback from customers like you. So if you’d like to share any other requests or feedback, please [reach out to us](https://ably.com/contact) and help us make Ably better for everyone. + +- Add JSDoc annotations to `ably.d.ts` [\#897](https://github.com/ably/ably-js/pull/897) +- Implement fetch as fallback if XHR and JSONP unsupported [\#1019](https://github.com/ably/ably-js/pull/1019) +- [EDX-158] Generate docs with TypeDoc and upload to sdk.ably.com [\#1017](https://github.com/ably/ably-js/pull/1017) +- [EDX-149] Add canonical docstring comments [\#1026](https://github.com/ably/ably-js/pull/1026) +- [EDX-207] Add intro blurb to generated documentation [\#1055](https://github.com/ably/ably-js/pull/1055) +- Add missing/undocumented docstrings [\#1064](https://github.com/ably/ably-js/pull/1064) +- fix: stop mutating `Defaults.agent` on client init [\#1068](https://github.com/ably/ably-js/pull/1068) + + ## [1.2.30](https://github.com/ably/ably-js/tree/1.2.30) (2022-10-05) - Add `connectivityCheckUrl` and `disableConnectivityCheck` client options [\#1051](https://github.com/ably/ably-js/pull/1051) - Fix EventEmitter.once when using array with promises [\#1046](https://github.com/ably/ably-js/pull/1046) From 292e44f27c5b6c1679e0c400fd25e88abcf5d60a Mon Sep 17 00:00:00 2001 From: Owen Pearson Date: Tue, 8 Nov 2022 14:37:30 +0000 Subject: [PATCH 2/2] chore: bump version for 1.2.31 release --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 48ff8929e6..7187e54879 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "ably", - "version": "1.2.30", + "version": "1.2.31", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "ably", - "version": "1.2.30", + "version": "1.2.31", "license": "Apache-2.0", "dependencies": { "@ably/msgpack-js": "^0.4.0", diff --git a/package.json b/package.json index f11e544b89..6d1dce8f27 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ably", "description": "Realtime client library for Ably, the realtime messaging service", - "version": "1.2.30", + "version": "1.2.31", "license": "Apache-2.0", "bugs": { "url": "https://github.com/ably/ably-js/issues",