We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
property
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
As noted in jsdoc/jsdoc#1407, the docs don't currently make it clear that the @property tag can be used to document an optional property, like so:
@property
/** * @typedef {Object} Something * @property {string} someProperty - required * @property {string} [anotherProperty] - optional */
We should update the @property docs to show an example of an optional property so that this feature is more discoverable.
The text was updated successfully, but these errors were encountered:
add example of optional property
20ed4cc
Fixes: jsdoc#172
5505441
No branches or pull requests
As noted in jsdoc/jsdoc#1407, the docs don't currently make it clear that the
@property
tag can be used to document an optional property, like so:We should update the
@property
docs to show an example of an optional property so that this feature is more discoverable.The text was updated successfully, but these errors were encountered: