https://github.com/zandaqo/jsdoc-plugin-named-defaults
A plugin for JSDoc to automatically pick up default values for pseudo-named parameters created using destructuring.
https://github.com/zandaqo/jsdoc-plugin-named-defaults
Last synced: about 1 year ago
JSON representation
A plugin for JSDoc to automatically pick up default values for pseudo-named parameters created using destructuring.
- Host: GitHub
- URL: https://github.com/zandaqo/jsdoc-plugin-named-defaults
- Owner: zandaqo
- License: mit
- Created: 2016-01-15T12:42:14.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-28T19:09:21.000Z (over 10 years ago)
- Last Synced: 2025-03-15T00:10:05.778Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This plugin for JSDoc 3 picks up default values for pseudo-named parameters created using destructuring, thus, allowing to avoid duplicating the values in comments.
# Install
```
npm i jsdoc-plugin-named-defaults
```
and add to the list of plugins in your JSDoc configuration file:
```
{
"plugins": ["./node_modules/jsdoc-plugin-named-defaults/named-defaults.js"]
}
```
# Example
```javascript
/**
* @param {number} start the starting index
* @param {Object} [details]
* @param {number} [details.amount] the amount of elements
* @param {string} [details.message] the message to show
* @param {Object} [options]
* @param {boolean} [options.async] the amount of elements
* @param {boolean} [options.sort] the message to show
*/
function getElements(start, { amount = 2, message = 'Done!' } = {}, {async = true, sort = false} = {}) {
}
```
the plugin will set `2` and `'Done!'` as the default values for `details.amount` and `details.message`, respectively, as well as `true` and `false` for `options.async` and `options.sort`.