[英]How can I properly document vue properties with type "Object" using jsDoc?
[英]JsDoc: How do I document that an object can have arbritrary (unknown) properties but with a particular type?
这与问题 30360391类似。 我想表达一个函数的参数是一个普通的 JS 对象,它可以具有任意属性(未知)名称,但所有属性都是具有固定属性的对象本身。
一个例子:函数就是这样
/**
* @param {Descriptor} desc
*/
function foo( desc ) {
// ...
}
一个典型的desc
看起来像
desc = {
unknownEntity1: {
priority: 5;
writable: false;
},
unknownEntity2: {
priority: 42;
writable: true;
},
unknownEntity3: {
priority: 9;
writable: false;
}
}
我已经有了
/**
* @typedef {Object} DescriptorEntry
* @property {number} priority - The priority of the entity
* @property {boolean} writable - True, if the entity can be modified
*/
我仍然需要一个用于Descriptor
的typedef
,它基本上表示 Descriptor 是一个具有任意属性但所有类型为DescriptorEntry
。 作为伪代码,它将类似于
/**
* @typedef {Object} Descriptor
* @property {DescriptorEntry} *
*/
当然,星号*
作为“任何属性”的通配符是无效的 Jsdoc 语法。 但是我该如何正确地做到这一点?
根据http://usejsdoc.org/tags-type.html ,从 JSDoc 3.2 开始,JSDoc 已经完全支持 Google Closure Compiler 类型表达式。 http://usejsdoc.org/tags-type.html#jsdoc-types描述了一种这样的格式:
{Object.<string, number>}
所以在你的情况下,你应该能够做到:
/**
* @typedef {Object.<string, DescriptorEntry>} Descriptor
*/
或者只是:
/**
* @typedef {{string, DescriptorEntry}} Descriptor
*/
你甚至可以替换string
用其自己的类型在上面的例子,如果你想有一个特殊类型,称为DescriptorName
或这样或细节允许的字符串值。
但是,有一个注意事项。 至少在我的情况下,虽然 JSDoc 没有拒绝后一种格式,至少使用默认模板,但它仅将其显示为“对象”而没有任何特殊细节。 但是,第一种格式显示正确。
这是PropertyDescriptor
和PropertyDescriptorMap
Typescript 接口。 (它们也被 PhpStorm 2020 用于代码完成): TypeScript/lib/lib.es5.d.ts
interface PropertyDescriptor {
configurable?: boolean;
enumerable?: boolean;
value?: any;
writable?: boolean;
get?(): any;
set?(v: any): void;
}
interface PropertyDescriptorMap {
[s: string]: PropertyDescriptor;
}
您可以直接将它们用作@type {}
或重新定义两者:
/**
* @typedef {Object} PropertyDescriptor
* @property {function(v: *): void} [set] - Set [name](v){...} 'accessor descriptor' only
* @property {function(): *} [get] - Get [name](){...} 'accessor descriptor' only
* @property {undefined|*} [value] - Value (primitive|func) valid in 'data descriptor' only
* @property {undefined|boolean} [writable] - Writable valid in 'data descriptor' only
* @property {undefined|boolean} [configurable] - Configurable valid in 'data && accessor - descriptor'
* @property {undefined|boolean} [enumerable] - Enumerable valid in 'data && accessor - descriptor'
*/
/**
* @typedef {Object<string,PropertyDescriptor>} PropertyDescriptorMap
*/
/**
* @type {PropertyDescriptor} myDescriptor
*/
let myDescriptor = {
configurable: true,
enumerable: true,
// value: {},
// writable: true,
get myGet(){},
set myGet(v){}
};
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.