首页 > 解决方案 > 在 JSDoc 中如何描述在其数据集中具有某些属性的 HTMLElement (DOMStringMap)?

问题描述

我有一个导出,它从参数的dataset属性中提取一些数据element,一个HTMLElement. 阅读有关记录“嵌套对象属性”的信息......我不知道以下是否是正确的做法:

/**
 * @param {HTMLElement} element The target HTML element
 * @param {string} element.dataset.idleClass The class to add when element is idle
 * @param {string} element.dataset.activeClass The class to add when element is active
 */
export const scrollTopWidget = element => {
  const {
    idleClass,
    activeClass
  } = element.dataaset;
  // ...
};

这是正确的吗?我是否也应该自己记录element.dataset它(将是 a DOMStringMap)?

标签: javascriptjsdoc

解决方案


推荐阅读