如何将 JsDoc 进行“混合”类型？

发布于 2024-10-16 04:41:59 字数 161 浏览 3 评论 0原文

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

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

梦幻的味道 2024-10-23 04:41:59

我找到了这样做的方法：

/**
 * @param {*} foo
 */
function bar(foo) {}

I found the way to do it:

/**
 * @param {*} foo
 */
function bar(foo) {}

回复收藏 0 原文

忆离笙 2024-10-23 04:41:59

使用 {}

有一个来自 http://usejsdoc.org/tags 的示例-type.html：

名为“myObj”的对象，其属性为“a”（数字）、“b”（一个
字符串）和“c”（任何类型）。
{{a：数字，b：字符串，c}} myObj
// 或者：
{对象} myObj
{number} myObj.a
{字符串} myObj.b
{} myObj.c

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 原文

你如我软肋 2024-10-23 04:41:59

在 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;
    }

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;
    }

回复收藏 0 原文

~没有更多了~