我可以导出document.js中的类型并将其链接为@param中的引用类型吗?

问题描述 投票:0回答:1

我想做的事情看起来像这样:

/**
* @class OrganizationDescriptor
*/
export type OrganizationDescriptor = {|
  organizationId: string
|};

然后当我使用此类型作为参数时,记录下来:

/**
* @param {OrganizationDescriptor} descriptor.organizationId returns {@link OrganizationDescriptor}
*/

我尝试分配一个函数,该函数返回一个带有OrganizationId字符串类型的对象。它确实可以工作,但是将需要大量时间来编辑我当前的代码库。

是否可以导出类型并将其用作参数的类型引用?

我运行文档v12.1.4并使用Node.js运行它

documentation jsdoc documentationjs
1个回答
0
投票

嗯,答案很简单。我要做的就是也编译类型文件并向类型中添加一些文本。

类似的东西,

/**
  * OrganizationDescriptor description
*/
export type OrganizationDescriptor = {|
  organizationId: string
|};

并用作

 /**
   * @param {object} descriptor
   * @param {OrganizationDescriptor} descriptor.organizationId 
 */
 info(descriptor: ActivityDescriptor) {

为我工作。

您也不要忘记有@type名称路径可用。可能有用。

© www.soinside.com 2019 - 2024. All rights reserved.