JSDoc 只描述对象值答案

【问题标题】：JSDoc describe object values onlyJSDoc 只描述对象值
【发布时间】：2018-08-27 15:46:26
【问题描述】：

假设我有这样的反对：

const Companies = {Mazda : {revenue:50000, employees:1000},
Honda: {revenue: 102324, employees:2031}}

还有这个功能：

const totalRevenue = (companies) => 
Object.values(companies)
.map(companyObject => companyObject.revenue)
.reduce((total, companyRevenue)=> total + companyRevenue)

如何使用JSDoc告诉函数 totalRevenue companies 对象是一个对象，它拥有的每个键都有一个 {revenue: Number, employees: Number} 类型的值

我对 WebStorm 能够理解的东西特别感兴趣。

【问题讨论】：

标签： webstorm jsdoc

【解决方案1】：

您可以使用{Object.<string, number>} 表示法描述对象中的每个键。在此处查看更多语法示例：http://usejsdoc.org/tags-type.html

针对您的具体情况：

/**
 * @param {Object.<string, {revenue: number, employees: number}>} companies
 */
const totalRevenue = (companies) => 
Object.values(companies)
.map(companyObject => companyObject.revenue)
.reduce((total, companyRevenue)=> total + companyRevenue)

【讨论】：

哇，正是我想要的！