как описать структуру объекта в jsdoc включая требуемые и опциональные поля — Q&A Хекслет
2026-02-26 20:31 Diff

Ответы

Для описания можно воспользоваться аннотациями

Например, можно использовать аннотацию @typedef, к которой можно добавить теги @property для описания каждого поля объекта:

В приведенном примере создается новый тип данных User, который представляет объект пользователя. У поля name тип данных является строкой и оно является требуемым. Поле age должно быть числом и также является требуемым. Поле email также должно быть строкой, но оно объявлено как опциональное, так как оно помечено скобками [ ].