[SDK-3857] Add typings for the tree-shakable version of the library #1498
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
github-actions
bot
temporarily deployed
to
staging/pull/1498/features
github-actions
bot
temporarily deployed
to
staging/pull/1498/typedoc
github-actions
bot
temporarily deployed
to
staging/pull/1498/bundle-report
lawrence-forooghian
force-pushed
the
1442-add-typings-for-tree-shakable-version
branch
from
997a9b0 to
61645ad
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1498/features
github-actions
bot
temporarily deployed
to
staging/pull/1498/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1498/typedoc
lawrence-forooghian
changed the title
lawrence-forooghian
changed the title
lawrence-forooghian
changed the title
lawrence-forooghian
force-pushed
the
1442-add-typings-for-tree-shakable-version
branch
from
61645ad to
3463ae3
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1498/features
github-actions
bot
temporarily deployed
to
staging/pull/1498/typedoc
github-actions
bot
temporarily deployed
to
staging/pull/1498/bundle-report
lawrence-forooghian
force-pushed
the
1442-add-typings-for-tree-shakable-version
branch
from
3463ae3 to
2ccb5eb
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1498/features
github-actions
bot
temporarily deployed
to
staging/pull/1498/typedoc
lawrence-forooghian
force-pushed
the
1442-add-typings-for-tree-shakable-version
branch
from
2ccb5eb to
869be09
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1498/features
github-actions
bot
temporarily deployed
to
staging/pull/1498/bundle-report
lawrence-forooghian
force-pushed
the
1489-remove-remaining-REST-code-from-BaseRealtime
branch
from
cf1d07a to
b75eb5b
Compare
These declarations are unreachable via the typings. The user needs to access these methods via the MessageStatic and PresenceMessageStatic interfaces.
These declarations are unreachable via the typings.
This allows users to import the module-based version by writing
```
import { BaseRealtime } from 'ably/modules'
```
instead of having to import 'ably/build/modules'.
I followed the guidance in [1] and [2].
[1] https://nodejs.org/api/packages.html#exports
[2] https://webpack.js.org/guides/package-exports/
I wasn’t sure of the best way to approach the typings of the modules (`Rest` etc). They should be opaque to the user (they shouldn’t be interacting with them directly and we want be free to change their interface in the future). There is an open issue to add support for opaque types to TypeScript [1], and people have suggested various sorts of ways of approximating them, which revolve around the use of `unique symbol` declarations. However, I don’t fully understand these solutions and so thought it best not to include them in our public API. So, for now, let’s just use `unknown`, the same way as we do for `CipherParams.key`. Resolves #1442. [1] microsoft/TypeScript#202
lawrence-forooghian
force-pushed
the
1442-add-typings-for-tree-shakable-version
branch
from
869be09 to
b839715
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1498/typedoc
Base automatically changed from
1489-remove-remaining-REST-code-from-BaseRealtime
to
integration/v2
November 21, 2023 00:17
lawrence-forooghian
deleted the
1442-add-typings-for-tree-shakable-version
branch
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.
Note: This PR is based on top of #1496; please review that one first.
This changes the way that the package does its exports, so that the user can import
ably/modules, and then adds typings for the library that you get when you do this import. See commit messages for more details.Resolves #1442.