Release 2.0.0 #1709
Merged
Release 2.0.0 #1709
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add better error handling for incorrect PLAYWRIGHT_BROWSER in runPlaywrightTests script
It doesn’t add any value, is inconsistent (we don’t create any other types for arrays), and I want to introduce a different type with the same name.
We were using TypeDoc’s declaration reference functionality [1] to disambiguate these, but this broke when we upgraded TypeDoc in 5f69795 — it started generating link text of ":type" instead of the name of the type. This is because TypeDoc 0.24 added the --useTsLinkResolution option, which is on by default. This option parses @link tags using the TypeScript compiler. It does this in order to more closely match the way in which editors such as VS Code will handle @link tags. However, the TypeScript compiler’s parsing does not support TypeDoc declaration syntax (and does not offer its own alternative), only falling back to TypeDoc @link parsing when TypeScript fails to parse a @link. (See the TypeDoc issue I raised [2] for further context.) So, stop using declaration references to disambiguate types. We still make some use of declaration references in modules.d.ts, to link to the types in ably.d.ts and to link to a specific overload of a method. These are still being parsed correctly (because TypeScript is unable to parse them) and there is no good alternative, so I’ll leave them as is, accepting that editors won’t handle them well (as was always the case). Resolves #1560. [1] https://typedoc.org/guides/declaration-references/ [2] TypeStrong/typedoc#2485
This applies the approach of 43a2d1d to the test changes that were added in `main` subsequent to that commit.
This applies the approach of 43a2d1d to some API calls that I missed in that commit.
Should have done this in ce9a3cf.
It’s not used outside the class.
A bit more readable, I guess.
Only allow standard (err, result) callbacks, so that we can bridge them to promises.
Preparation for using promises internally in the codebase. Part of #1535; will remove the functional interface to Multicaster if/when it’s no longer needed.
Copied from the tests. We’ll use it for bridging between promise-using methods and callback-using methods as we start changing the codebase to use promises internally.
The return type of `restMixin.history(...)` is `void`.
This adds Promise overload signatures to all of the methods which: 1. offer dual callback / promise operation, and 2. are called internally in the codebase This will allow us to switch these internal calls to use the promise-based versions of these methods.
Whenever we call a method that offers dual callback/promise operation, we now use the promise-based version. This in preparation for removing the callback functionality from these methods.
Methods that previously offered the ability to use callbacks or promises now only offer promises.
Taken from sdk-api-reference commit 7cc5a28 (see [1], not merged yet). [1] ably/sdk-api-reference#40
Based on e71ed5f...2e12459. Note that 1.2.50, to which this guide refers, doesn't exist yet. We’ll do that in #1672. The description of the stats response changes comes from Simon in [1], and the description of the removal of connection upgrades comes from Owen in [2]. HTML tags used for headings so that I can specify a fixed `id` to use in fragment links, because I’m probably going to keep editing the headings and so if I rely on the generated headings then I’ll almost certainly end up with a broken link. (GitHub doesn’t seem to support the custom heading ID syntax described in [3].) And we don’t have a linter that checks for broken fragment links. Resolves ECO-1416. [1] #1670 (comment) [2] #1670 (comment) [3] https://www.markdownguide.org/extended-syntax/#heading-ids
[ECO-1416] Add migration guide for v2
…-into-v2 Fixes the merge conflict introduced by b9bb651.
Merge `main` into `integration/v2`
Add migration guide for react hooks for ably-js v2
Use `useLayoutEffect` when calling `.setOptions()` in `ChannelProvider`
Based on changes between dc761e7...c02ec56
[ECO-4122] Draft 2.0.0 changelog
github-actions
bot
temporarily deployed
to
staging/pull/1709/bundle-report
lawrence-forooghian
approved these changes
Mar 21, 2024
ttypic
approved these changes
Mar 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog for v2 release was discussed in a separate PR due to its complexity, see: #1656