如何描述一个对象类型，除了特定属性之外还可以具有附加属性？

huangapple
go评论90阅读模式
英文:

How to describe an object type that can have additional properties apart from specific ones?

问题

/**

  • @typedef {object} User
  • @property {string} name - 用户姓名
  • @property {number} age - 用户年龄
  • @property {*} [from] - 用户来自哪里
  • @property {*} [to] - 用户要去哪里
    */
  2. <details>
  3. <summary>英文:</summary>
  5. I have a data type called User currently, and I want it to have two mandatory properties, name and age. In addition, users should be able to add any number of other properties to it. How should I describe it in JSDoc to support this requirement without encountering errors?

/**

  • @typedef {object} User
  • @property {string} name - user name
  • @property {number} age -user age
    */

/**

  • @type {User}
    */
    const tom={
    name:'cx',
    age:25,
    from:'sh',// error
    to:'bj',// error
    }
  2. </details>
  5. # 答案1
  6. **得分**: 1
  8. 也许你可以添加一个类似于[这里](https://jsdoc.app/tags-param.html)描述的任意类型的`{*}`属性，以消除错误。
  10. ```js
  11. /**
  12.  * @typedef {Object} User
  13.  * @property {string} name - 用户名（必填）
  14.  * @property {number} age - 用户年龄（必填）
  15.  * @property {*} [key: value] - 用户可以添加的附加属性（可选）
  16.  */
  18. /**
  19.  * @type {User}
  20.  */
  21. const tom = {
  22.   name: 'cx',
  23.   age: 25,
  24.   from: 'sh', // 没有错误
  25.   to: 'bj', // 没有错误
  26. };

编辑：经过一些搜索，我找到了这个帖子。你能否检查是否解决了错误。

  1. /**
  2.  * @typedef {object} User
  3.  * @property {string} name 用户名
  4.  * @property {number} age 用户年龄
  5.  */
  7. /**
  8.  * @typedef {Object.<string, string>} Descriptor
  9.  * @typedef {User & Descriptor} UserWithDetails 带有详细信息的用户
  10.  */
  13. /**
  14.  * @type {UserWithDetails}
  15.  */
  16. const tom = {
  17.   name: "cx",
  18.   age: 25,
  19.   from: "sh",
  20.   to: "bj",
  21. };

编辑后的编辑：如果上面的方法有效，也许你甚至可以通过以下方式简化它。

  1. /**
  2.  * @typedef {object} User
  3.  * @property {string} name - 用户名
  4.  * @property {number} age - 用户年龄
  5.  * @property {Object.<string, string>} [additionalProperties] - 附加键值对
  6.  */
  8. /**
  9.  * @type {User}
  10.  */
  11. const tom = {
  12.   name: "cx",
  13.   age: 25,
  14.   from: "sh",
  15.   to: "bj",
  16. };
英文:

perhaps you can add a {*} property similar to the any-type described here to get rid of the error

  1. /**
  2.  * @typedef {Object} User
  3.  * @property {string} name - User name (mandatory)
  4.  * @property {number} age - User age (mandatory)
  5.  * @property {*} [key: value] - Additional properties that users can add (optional)
  6.  */
  8. /**
  9.  * @type {User}
  10.  */
  11. const tom = {
  12.   name: &#39;cx&#39;,
  13.   age: 25,
  14.   from: &#39;sh&#39;, // No error
  15.   to: &#39;bj&#39;, // No error
  16. };

Edit: after some searching, I've found this thread. Could you check if this resolves the errors

  1. /**
  2.  * @typedef {object} User
  3.  * @property {string} name user name
  4.  * @property {number} age user age
  5.  */
  7. /**
  8.  * @typedef {Object.&lt;string, string&gt;} Descriptor
  9.  * @typedef {User &amp; Descriptor} UserWithDetails user with details
  10.  */
  13. /**
  14.  * @type {UserWithDetails}
  15.  */
  16. const tom = {
  17.   name: &quot;cx&quot;,
  18.   age: 25,
  19.   from: &quot;sh&quot;,
  20.   to: &quot;bj&quot;,
  21. };

Edit on edit: If the above works perhaps you can even simplify it by doing

  1. /**
  2.  * @typedef {object} User
  3.  * @property {string} name - User name
  4.  * @property {number} age - User age
  5.  * @property {Object.&lt;string, string&gt;} [additionalProperties] - Additional key-value pairs
  6.  */
  8. /**
  9.  * @type {User}
  10.  */
  11. const tom = {
  12.   name: &quot;cx&quot;,
  13.   age: 25,
  14.   from: &quot;sh&quot;,
  15.   to: &quot;bj&quot;,
  16. };

huangapple
  • 本文由 发表于 2023年6月15日 13:59:16
  • 转载请务必保留本文链接：https://go.coder-hub.com/76479513.html
  • javascript
  • jsdoc
  • visual-studio-code
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定