Handle TypeScript optional property syntax #76
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
Daniel-Knights
force-pushed
the
handle-typescript-optional-properties-syntax
branch
from
b235e9a to
5b4e889
Compare
ahocevar
reviewed
May 16, 2025
|
|
||
| ```js | ||
| /** | ||
| * @type {{a: number, b: string}} |
There was a problem hiding this comment.
Did you try if @type {{a: number, b: string=}} would work in JSDoc? It would be nice if we could keep the information that b is meant to be optional.
There was a problem hiding this comment.
TS doesn't allow this syntax
There was a problem hiding this comment.
I meant the translation to JSDoc, not the input type annotation.
There was a problem hiding this comment.
@type {{a: number, b: string=}} ends up as Object in the generated docs.
You'd have to define it as:
/**
* @type {object}
* @property {number} a
* @property {string=} b
*/To output docs for each property and whether or not they're optional
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 PR adds support for TypeScript optional property syntax by removing
?characters after keys in object types.