Fix for TS2742 (workaround) #27
Merged
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
ehmicky
reviewed
Apr 8, 2024
| ## Known limitations and issues | ||
|
|
||
| For known limitations and issues related to TypeScript's current capabilities, | ||
| please see the comments in [src/main.d.ts](../src/main.d.ts). |
ehmicky
reviewed
Apr 8, 2024
| * See: | ||
| * | ||
| * - [modern-errors issue #18](https://github.com/ehmicky/modern-errors/issues/18) | ||
| * - [TypeScript issue #47663](https://github.com/microsoft/TypeScript/issues/47663) |
ehmicky
approved these changes
Apr 8, 2024
|
Thanks a lot for this PR @jmchambers. |
|
@all-contributors Could you please add @jmchambers for test, bug? |
|
I've put up a pull request to add @jmchambers! 🎉 |
No problem, @ehmicky, I'm glad to help! 🚀 |
2 tasks
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.
This fixes #18.
The temporary fix, as discussed in the issue, is to export additional private types. I've grouped all the types being exported for this reason together, at the bottom of src/main.d.ts, and added JSDoc comments in the files where the types are defined, warning that they are private, and won't be exported in the future.
I've tagged the JSDoc comments with
@privateas opposed to@deprecated, as the latter was very "noisy" in vscode popovers, and@privateis closer to the truth anyway. The comments also link to the relevant issues in this repo and the TypeScript repo. I used markdown links, rather than JSDoc@linktags, as vscode messes up the formatting of the latter.I have added tests (we are enforcing 100% test coverage).README.md, thedocsdirectory (ifany) and the
examplesdirectory (if any).seen below.