Simple question, how do I document that "Mixed-type"? I know I could just list all possible types like {null|undefined|String|Number|Object}
and end up finding myself missing one and making it overly complex. I tried using the Mixed keyword, but it popups errors in many IDEs such as WebStorm.
How to JsDoc a "mixed" type?
20.5k views Asked by Tower At
3
There are 3 answers
0
On
Use {}
There is an example from http://usejsdoc.org/tags-type.html:
An object called 'myObj' with properties 'a' (a number), 'b' (a string) and 'c' (any type).
{{a: number, b: string, c}} myObj // or: {Object} myObj {number} myObj.a {string} myObj.b {} myObj.c
0
On
In JSDoc, you can describe values in different ways. For example, using the following tags @type
, @param
, @return
.
You can specify optional values using the "?". Here is an example
/**
* Returns string or null
*
* @param {?string} nullableStringArgument
*
* @return {?string}
*/
function returnNullableString (nullableStringArgument = null) {
/** @type {?string} */
const nullableString = [null, 'string'][Math.floor(Math.random() * 2)];
return nullableString;
}
I found the way to do it: