How to JsDoc a “mixed” type?
-
29-10-2019 - |
Question
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.
Solution
I found the way to do it:
/**
* @param {*} foo
*/
function bar(foo) {}
OTHER TIPS
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
Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow