Введение

Раздел «Файлы объявлений» предназначен для обучения написанию качественных файлов объявлений TypeScript. Для начала нам нужно предположить базовое знакомство с языком TypeScript.

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

Наиболее распространенный случай для изучения работы файлов .d.ts — это типизация пакета npm без типов. В этом случае вы можете сразу перейти к Модулям .d.ts.

Раздел «Файлы объявлений» разбивается на следующие разделы.

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

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

В разделе «Шаблоны» вы найдете ряд файлов объявлений, которые могут служить полезной отправной точкой при написании нового файла. Если вы уже знаете свою структуру, см. раздел «Шаблоны d.ts» в боковой панели.

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

Для опытных авторов, заинтересованных в механизмах работы файлов объявлений, раздел Подробное изучение объясняет многие продвинутые концепции написания объявлений и демонстрирует, как использовать эти концепции для создания более чистых и интуитивных файлов объявлений.

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

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