Перейти к содержанию

Введение

Это руководство предназначено для обучения написанию высококачественных файлов объявлений для TypeScript.

Предполагается, что читатель на базовом уровне знаком с языком TypeScript. Если это не так, то для ознакомления с основными принципами, а особенно с типами и пространствами имен, рекомендуется прочесть Руководство по TypeScript.

Руководство разбито на следующие разделы.

Структуры библиотек

Руководство по структурам библиотек поможет понять распространенные форматы библиотек и то, как писать правильные файлы объявлений для каждого формата. Если вы редактируете уже существующий файл, то скорее всего, данный раздел читать не обязательно. Авторы новых файлов объявлений должны прочесть данный раздел, чтобы верно понять, как формат библиотеки влияет на написание файлов объявлений.

"Как можно" и "Как нельзя"

Многих часто встречающихся ошибок в файлах объявлений можно избежать. Раздел "Как можно" и "Как нельзя" указывает на распространенные ошибки, описывает, как их находить и исправлять. Этот раздел должны прочесть все, чтобы научиться не допускать распространенных ошибок.

На примере

Зачастую требуется создать файл объявлений, когда есть только примеры использования нужной библиотеки. Раздел На примере показывает часто встречающиеся шаблоны API и то, как они описываются в файлах объявлений. Данный раздел предназначен для новичков в TypeScript, которые, возможно, еще не знакомы со всеми конструкциями языка.

Глубокое погружение

Раздел для бывалых разработчиков, интересующихся, как работают файлы объявлений "под капотом". Данный раздел объясняет множество сложных принципов написания объявлений, и показывает, как использовать их для создания более ясных и простых файлов объявлений.

/templates

В директории templates находятся файлы объявлений, которые могут послужить отправной точкой для создания нового файла объявлений. См. документацию касательно структур библиотек, чтобы понять, какой шаблон использовать.

Публикация в npm

Раздел Публикация объясняет, как опубликовать файлы объявлений для npm-пакета и управлять зависимостями.

Поиск и установка файлов объявлений

Для пользователей JavaScript-библиотек предназначен раздел Использование, который предлагает простые шаги для нахождения и установки необходимых файлов объявлений.

Ссылки