Question

这与question 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
 */

我仍然需要typedef Descriptor基本上表达描述符是具有任意属性但所有类型DescriptorEntry的对象。作为伪代码，它将类似于

/**
 * @typedef {Object} Descriptor
 * @property {DescriptorEntry} *
 */

当然，星号*作为＆＃34;任何属性的通配符＆＃34;是无效的Jsdoc语法。但是我该怎么做呢？

Answer 1

这是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){}
};

Answer 2

每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至少在默认模板中没有拒绝后者的格式，但它只是将其显示为“对象”而没有任何特殊细节。但是，第一种格式可以正确显示。

JsDoc：我如何记录对象可以具有arbritrary（未知）属性但具有特定类型？

2 个答案: