JSDOC में टाइप किए गए पैरामीटर का विस्तार कैसे करें?

Question

मान लें कि आप एक ES6 वर्ग के अंदर (प्रलेखन) निम्नलिखित कोड है:

/** 
* @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){ 

} 

अब मैं एक और समारोह दस्तावेज़ के लिए चाहते हैं, चलो यह test2 नाम करते हैं। यह फ़ंक्शन बिल्कुल options ऑब्जेक्ट लेता है, लेकिन किसी अन्य प्रॉपर्टी parent की आवश्यकता होती है।

अनावश्यक विकल्पों को दस्तावेज किए बिना इसे कैसे दस्तावेज़ित करें? निरर्थक साधन:

/** 
* @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){ 

} 

Answer 1

यह प्रयास करें GitHub पर

/** 
* @typedef {object.<string>} Test~options 
* @property {array} elements - An array containing elements 
* @property {number} length - The array length 
*/ 

/** 
* @param {Test~options} opt - Option object 
*/ 
test(opt){ 

} 

/** 
* @typedef {Test~options} Test~options2 
* @property {object} parent - The parent element 
*/ 

/** 
* @param {Test~options2} opt - Option object 
*/ 
test2(opt){ 

}