Как документировать массив "список параметров как" в JSDoc?

В JavaScript распространена работа с массивами, которые по сути являются списками аргументов: небольшой фиксированной длины и известными типами для каждой позиции. Это особенно верно для ECMAScript 6, который представил такие функции, как оператор отдыха, оператор распространения и протокол итератора.

Я хотел бы документировать функцию, которая возвращает объект итератора, для перебора пар ключ / значение. В идеале я бы хотел быть конкретным в своем типе. Возможно ли это сделать с (любым) JSDoc? Вот моя последняя попытка, но я не знаю, насколько она действительна:

/**
 * @returns { { next: function(): {done: boolean, value: [string, *]} } }
 */

jsdoc-to-markdown жалуется на синтаксис, но это может быть с их стороны, а не JSDoc 3. Если так, я отправлю им отчет об ошибке позже.

Изменить: Вот пример объекта, который может быть возвращен:

{
    next: function () {
        return {
            done: false,
            value: ['answer', 42]
        };
    }
}

0 ответов

Другие вопросы по тегам