In JSDoc, the best documentation I can find shows to use the following if you have an array of a specific type (such as an array of strings) as:
/**
* @param {Array.<string>} myStrings All my awesome strings
*/
function blah(myStrings){
//stuff here...
}
How would you replace the below question marks specify an array of objects?
/**
* @param {???????} myObjects All of my equally awesome objects
*/
function blah(myObjects){
//stuff here...
}
To declare an array of objects in TypeScript, set the type of the variable to {}[] , e.g. const arr: { name: string; age: number }[] = [] . Once the type is set, the array can only contain objects that conform to the specified type, otherwise the type checker throws an error. Copied!
The @param tag provides the name, type, and description of a function parameter. The @param tag requires you to specify the name of the parameter you are documenting.
We can use the following ways to select a random element from an array in JavaScript: Math. random() , array. length , and Math.
Using an array literal is the easiest way to create a JavaScript Array. Syntax: const array_name = [item1, item2, ...]; It is a common practice to declare arrays with the const keyword.
You should be more specific what you mean by JSDoc - this is a generic term covering pretty much all the JavaDoc-style documentation tools for JavaScript.
The syntax you used for array of strings looks like the one supported by Google Closure Compiler.
Using this, an array of Objects would be:
/**
* @param {Array.<Object>} myObjects
*/
Or just an array of anything - this should work with pretty much all doc tools:
/**
* @param {Array} myArray
*/
jsdoc-toolkit, JSDoc 3, and JSDuck support the following syntax to denote an array of objects:
/**
* @param {Object[]} myArray
*/
In case you know the keys and the variable type of the values you can also do:
/**
* @param {Array.<{myNumber: Number, myString: String, myArray: Array}>} myObjects
*/
or
/**
* @param {{myNumber: Number, myString: String, myArray: Array}[]} myObjects
*/
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With