Fixed optional param in JSDoc and generated TS definition #99
Conversation
This file contains hidden or 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
| thanks a lot for your PR, I will prepare new version. |
puneet0191 added a commit that referenced this pull request Nov 6, 2021
* Fixed optional param in JSDoc and generated TS definition (#99) * [TASK] fix relative paths for Mochawesome context screenshots (#97) * [TASK] fix relative paths for Mochawesome context screenshots * [TASK] improve relative path generation for cases where report is not in default folder * [TASK] switch to Path.relative * [TASK] add more pessimistic check for undefined options * [TASK] resolveRelativePath should not be public * [FEATURE] allow resemble.compare even if dimensions are not the same (#96) * [FEATURE] allow resemble.compare even if dimensions are not the same \n\nsee #94 * fix default value overriding custom value "false" * Update Version, Prepare for release. Co-authored-by: Jaromir Obr <jaromir.obr@gmail.com> Co-authored-by: jpmschuler <jpmschuler@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Motivation:
To have working Resemble methods in TypeScript tests + autocompletion by IntelliSense in VSCode.
If TS definition doesn't exist, you get this in your TS test:
If TS definition exists, everything works well:
I think it solves #77
I fixed:
optionsin JSDoc was set as optional (https://jsdoc.app/tags-param.html#optional-parameters-and-default-values) so that generated TS definition allows omit it (otherwise TS check fails when callingI.see*without that)npx -p typescript tsc index.js --declaration --allowJs --emitDeclarationOnly, see https://www.typescriptlang.org/docs/handbook/declaration-files/dts-from-js.html