JSDoc, документирование словаря с записями по умолчанию - PullRequest
0 голосов
/ 18 января 2019

В машинописном тексте я могу задокументировать словарь / карту, в которой есть определенные заданные записи, но все же это словарь / карта (как вы можете добавлять или удалять записи), как это

type Foo = {
    bar: number;
    moo: number;
    [key: string]: number;
};

Есть ли эквивалент JSDoc?

1 Ответ

0 голосов
/ 20 января 2019

Вы можете использовать этот синтаксис для параметров

/**
 * @param {Object.<string, number>} foo
 */

Я не уверен в том, чтобы использовать то же самое с @typedef, но думаю, это тоже должно работать:

/**
 * @typedef {Object.<string, number>} Foo
 */

Тип документов http://usejsdoc.org/tags-type.html

...