{"id":18285515,"url":"https://github.com/zandaqo/jsdoc-plugin-named-defaults","last_synced_at":"2025-04-09T06:16:52.124Z","repository":{"id":57284213,"uuid":"49718164","full_name":"zandaqo/jsdoc-plugin-named-defaults","owner":"zandaqo","description":"A plugin for JSDoc to automatically pick up default values for pseudo-named parameters created using destructuring.","archived":false,"fork":false,"pushed_at":"2016-01-28T19:09:21.000Z","size":4,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-15T00:10:05.778Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zandaqo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-15T12:42:14.000Z","updated_at":"2023-09-17T14:23:58.000Z","dependencies_parsed_at":"2022-09-07T21:51:10.697Z","dependency_job_id":null,"html_url":"https://github.com/zandaqo/jsdoc-plugin-named-defaults","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zandaqo%2Fjsdoc-plugin-named-defaults","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zandaqo%2Fjsdoc-plugin-named-defaults/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zandaqo%2Fjsdoc-plugin-named-defaults/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zandaqo%2Fjsdoc-plugin-named-defaults/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zandaqo","download_url":"https://codeload.github.com/zandaqo/jsdoc-plugin-named-defaults/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987285,"owners_count":21028895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T13:16:55.485Z","updated_at":"2025-04-09T06:16:52.099Z","avatar_url":"https://github.com/zandaqo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"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.\n\n# Install\n```\nnpm i jsdoc-plugin-named-defaults\n```\nand add to the list of plugins in your JSDoc configuration file:\n```\n{\n    \"plugins\": [\"./node_modules/jsdoc-plugin-named-defaults/named-defaults.js\"]\n}\n```\n# Example\n```javascript\n/**\n* @param {number} start the starting index\n* @param {Object} [details]\n* @param {number} [details.amount] the amount of elements\n* @param {string} [details.message] the message to show\n* @param {Object} [options]\n* @param {boolean} [options.async] the amount of elements\n* @param {boolean} [options.sort] the message to show\n*/\nfunction getElements(start, { amount = 2, message = 'Done!' } = {}, {async = true, sort = false} = {}) {\n\n}\n```\nthe 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`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzandaqo%2Fjsdoc-plugin-named-defaults","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzandaqo%2Fjsdoc-plugin-named-defaults","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzandaqo%2Fjsdoc-plugin-named-defaults/lists"}