Есть ли преимущество использования файлов объявлений над источниками в машинописи? - PullRequest
Новая
       15

Есть ли преимущество использования файлов объявлений над источниками в машинописи?

1 голос
/ 01 февраля 2020

При создании и публикации библиотеки с использованием машинописи есть 2 варианта:

  1. Создание файлов объявлений d.ts вместе с файлом javascript в комплекте и затем в package.json указывают на это с:

    "типами": "./dist/mylib.d.ts"

  2. Не генерировать файлы объявлений и указывать непосредственно на исходный код в package.json witt:

    «типы»: «./src/index.ts"

В чем преимущество каждого из них?

1 Ответ

3 голосов
/ 01 февраля 2020

Я предлагаю следующую стратегию:

Пакет библиотеки

В пакете библиотеки распространяйте только соответствующие JavaScript с файлами объявлений. Это дает преимущество в уменьшении размера пакета, предоставляя разработчикам возможность использовать вашу библиотеку либо с JavaScript, либо с TypeScript.

Репозиторий кода

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

...