41

简单的问题,我如何记录“混合类型”?我知道我可以列出所有可能的类型,例如{null|undefined|String|Number|Object},最终发现自己错过了一种并使其过于复杂。我尝试使用 Mixed 关键字,但它在许多 IDE(例如 WebStorm)中弹出错误。

4

3 回答 3

74

我找到了这样做的方法:

/**
 * @param {*} foo
 */
function bar(foo) {}
于 2011-07-21T15:32:52.560 回答
3

使用{}

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
于 2017-09-15T13:21:21.970 回答
3

在 JSDoc 中,您可以用不同的方式描述值。例如,使用以下标签@type@param@return。您可以使用“?”指定可选值。这是一个例子

    /**
     * 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;
    }
于 2019-11-01T04:55:21.573 回答