Wie erweitere ich einen typedef-Parameter in JSDOC?
Angenommen, Sie haben den folgenden Code in einer ES6-Klasse (Dokumentation):
/**
* @typedef Test~options
* @type {object.<string>}
* @property {array} elements - An array containing elements
* @property {number} length - The array length
*/
/**
* @param {Test~options} opt - Option object
*/
test(opt){
}
Nun möchte ich eine weitere Funktion dokumentieren, nennen wir sietest2
. Diese Funktion benötigt genau das gleicheoptions
Objekt, braucht aber eine andere Eigenschaftparent
.
Wie kann dies dokumentiert werden, ohne redundante Optionen zu dokumentieren? Redundant bedeutet:
/**
* @typedef Test~options
* @type {object.<string>}
* @property {array} elements - An array containing elements
* @property {number} length - The array length
*/
/**
* @param {Test~options} opt - Option object
*/
test(opt){
}
/**
* @typedef Test~options2
* @type {object.<string>}
* @property {array} elements - An array containing elements
* @property {number} length - The array length
* @property {object} parent - The parent element
*/
/**
* @param {Test~options2} opt - Option object
*/
test2(opt){
}