包含句点的JSDoc属性名称

Question

如何在JSDoc / VSCode包含句点时记录对象的属性？

例如：

/**
 * @type {PersonObject}
 */
let personObject = {
   "first.last": "John Doe", // optional
   "age": 31
}

/**
 * @typedef {Object} PersonObject
 * @property {String} [first.last]
 * @property {Number} age
 */

{“message”：“类型'{\\”first.last \\“：string; age：number;}'不能分配给'PersonObject'类型。\\ n对象文字只能指定已知属性，而''”只能指定。在'PersonObject'类型中不存在last \\“'。”，“source”：“ts”，}

Answer 1

假设您正在使用Closure Compiler，或至少与其兼容的JSDoc风格：

我建议使用新的@typedef语法，它似乎在这个例子中起作用 。

/**
 * @typedef  {{
 *            first.last:string,
 *            age:number,
 *          }}
 */
var PersonObject;

/**
 * @type {PersonObject}
 */
let personObject = {
   "first.last": "John Doe", // optional
   "age": 31
}

请注意，当您在任一位置更改“first.last”时，Closure将发出警告 ：

JSC_TYPE_MISMATCH: initializing variable
found   : {age: number, firstzzzzz: string}
required: {age: number, first.last: string}
missing : [first.last]
mismatch: [] at line 14 character 19
let personObject = {