Как сделать JsDoc «смешанным» типом? - PullRequest
30 голосов
/ 05 февраля 2011

Простой вопрос, как мне документировать этот «смешанный тип»? Я знаю, что мог бы просто перечислить все возможные типы, такие как {null|undefined|String|Number|Object}, и в итоге я бы пропустил один и сделал его слишком сложным. Я попытался использовать ключевое слово Mixed, но во многих IDE, таких как WebStorm, появляются ошибки.

Ответы [ 2 ]

56 голосов
/ 21 июля 2011

Я нашел способ сделать это:

/**
 * @param {*} foo
 */
function bar(foo) {}
2 голосов
/ 15 сентября 2017

Использование {}

Есть пример из http://usejsdoc.org/tags-type.html:

Объект с именем 'myObj' со свойствами 'a' (число), 'b' (строка) и 'c' (любой тип) .

{{a: number, b: string, c}} myObj
// or:
{Object} myObj
{number} myObj.a
{string} myObj.b
{} myObj.c
...