Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juliendargelos/jsdoc-inheritparams-plugin
Inherit parameters documentation from any class or function with JSDoc.
https://github.com/juliendargelos/jsdoc-inheritparams-plugin
Last synced: 18 days ago
JSON representation
Inherit parameters documentation from any class or function with JSDoc.
- Host: GitHub
- URL: https://github.com/juliendargelos/jsdoc-inheritparams-plugin
- Owner: juliendargelos
- License: mit
- Created: 2019-01-29T19:25:55.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-24T09:49:57.000Z (over 5 years ago)
- Last Synced: 2024-12-11T07:48:30.665Z (about 2 months ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSDoc inherit params plugin
Inherit parameters documentation from any class or function with JSDoc.
## Install
With yarn:
```bash
yarn add jsdoc-inheritparams-plugin --dev
```
With npm:
```bash
npm install jsdoc-inheritparams-plugin --save-dev
```
Add the plugin to your JSDoc config:
```json
{
"plugins": [
"node_modules/jsdoc-inheritparams-plugin"
]
}
```
## Usage
> All these examples work with any kind of function (constructor, member's function, global function).
Consider the following `User` class:
```javascript
/**
* Represents a user.
* @class User
* @param {string} firstname User's firstname.
* @param {string} lastname User's lastname.
*/
class User {
constructor(firstname, lastname) {
this.firstname = firstname
this.lastname = lastname
}
}
```
#### Inherit parameters
> `@inheritparams` automatically determines super class from `@extends`.
```javascript
/**
* Represents an admin user.
* @class AdminUser
* @extends User
* @inheritparams
*/
class AdminUser extends User {
constructor(...args) {
super(...args)
this.admin = true
}
}
```
#### Specify super class or function
> You can give an explicit super class of function to inherit parameters from.\
> The given class or function can be any valid JSDoc path.
```javascript
/**
* Represents an admin user.
* @class AdminUser
* @extends User
* @inheritparams User
*/
class AdminUser extends User {
constructor(...args) {
super(...args)
this.admin = true
}
}
```
#### Add extra parameters:
```javascript
/**
* Represents an admin user.
* @class AdminUser
* @extends User
* @inheritparams
* @param {string} username Admin username.
* @param {string} email Admin email.
* @param {string} password Admin password.
*/
class AdminUser extends User {
constructor(firstname, lastname, username, email, password) {
super(firstname, lastname)
this.admin = true
this.username = username
this.email = email
this.password = password
}
}
```
#### Specify inherited parameters offset
> Prefix the offset with a colon: `@inheritparams :4`.\
> Super class or function path can be specified before offset: `@inheritparams CustomClass:4`.\
> The default offset is `0` so inherited parameters are inserted before extra parameters (see previous example).\
> The offset can be negative so it start from the end of extra parameters.
```javascript
/**
* Represents an admin user.
* @class AdminUser
* @extends User
* @inheritparams :1
* @param {string} username Admin username.
* @param {string} email Admin email.
* @param {string} password Admin password.
*/
class AdminUser extends User {
constructor(
username,
firstname, lastname, // Offset 1
email,
password
) {
// ...
}
}
```
```javascript
/**
* Represents an admin user.
* @class AdminUser
* @extends User
* @inheritparams :2
* @param {string} username Admin username.
* @param {string} email Admin email.
* @param {string} password Admin password.
*/
class AdminUser extends User {
constructor(
username,
email,
firstname, lastname, // Offset 2
password
) {
// ...
}
}
```
```javascript
/**
* Represents an admin user.
* @class AdminUser
* @extends User
* @inheritparams :3
* @param {string} username Admin username.
* @param {string} email Admin email.
* @param {string} password Admin password.
*/
class AdminUser extends User {
constructor(
username,
email,
password,
firstname, lastname, // Offset 3
) {
// ...
}
}
```
```javascript
/**
* Represents an admin user.
* @class AdminUser
* @extends User
* @inheritparams :-1
* @param {string} username Admin username.
* @param {string} email Admin email.
* @param {string} password Admin password.
*/
class AdminUser extends User {
constructor(
username,
email,
password,
firstname, lastname, // Offset -1
) {
// ...
}
}
```
```javascript
/**
* Represents an admin user.
* @class AdminUser
* @extends User
* @inheritparams :-2
* @param {string} username Admin username.
* @param {string} email Admin email.
* @param {string} password Admin password.
*/
class AdminUser extends User {
constructor(
username,
email,
firstname, lastname, // Offset -2
password
) {
// ...
}
}
```