javascript - 如何使用 jsdoc 记录解构变量

Question

我有这样的东西:

let { total } = settings;

如何记录总变量？我试过这样的事情:

/**
 * @type {Object}
 * @property {String} total.test
 */
let { total } = settings;

但这似乎不是正确的方法。

有什么建议吗？

Answer 1

@Tommy-Pepsi Gaudreau他对原始问题的评论非常接近。

这是一个 example in the closure compiler tool @ closure-compiler.appspot.com

let /** @type {Object<string|boolean>} */ settings = {};
let str = 'string';
let bool = true;
settings.b = bool;
settings.s = str;

// Note that at this point, b and s are of the type {string|boolean}.

let {/** @type {string} */ s,/** @type {boolean} */ b } = settings;

console.log({b, s});

// But now, when we assign the wrong types, we get a warning.

b='warn';
s=false;

警告数:2

JSC_TYPE_MISMATCH: assignment
found   : string
required: boolean at line 15 character 4
    b='warn';
    ^
JSC_TYPE_MISMATCH: assignment
found   : boolean
required: string at line 16 character 4
    s=false;
    ^

编辑 - 2018 年 9 月 27 日:我减少了初始输入的数量以确保/澄清类型没有被忽略，并且警告来自解构中的类型.