Могу ли я экспортировать тип в документацию js и связать его с ссылочным типом в @param?

Question

То, что я хочу сделать, выглядит следующим образом:

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

, а затем, когда я использую этот тип в качестве параметра, задокументируйте его:

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

Я попытался назначить функцию, которая возвращает объект со строковым типом organizationId. Это работает, но потребует много времени на редактирование моей текущей базы кода.

Есть ли способ экспортировать тип и использовать его как ссылку на тип параметра?

Я запускаю документацию v12 .1.4 и запустить его, используя Node.js

Answer 1

Ну, ответ довольно прост. Все, что мне нужно было сделать, это также перенести файл типов и добавить текст к типу.

примерно так:

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

и использовать его как

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

работал для меня.

Вы также не должны забывать, что есть доступный @ namepath. Может быть полезным.