Использование зависимостей из npm

В проектах Kotlin/JS все зависимости можно управлять с помощью плагина Gradle. Это включает библиотеки Kotlin/Multiplatform, такие как kotlinx.coroutines, kotlinx.serialization, или ktor-client.

Для использования пакетов JavaScript из npm, Gradle DSL предоставляет функцию npm, которая позволяет указать пакеты, которые вы хотите импортировать из npm. Рассмотрим импорт пакета NPM под названием is-sorted.

Соответствующая часть в файле сборки Gradle выглядит следующим образом:

dependencies {
    // ...
    implementation(npm("is-sorted", "1.0.5"))
}

Поскольку модули JavaScript обычно имеют динамическую типизацию, а Kotlin — статически типизированный язык, вам нужен адаптер. В Kotlin такие адаптеры называются внешними объявлениями. Для пакета is-sorted, который предлагает только одну функцию, это объявление невелико. В папке исходных файлов создайте новый файл, назовите его is-sorted.kt, и заполните его следующим содержимым:

@JsModule("is-sorted")
@JsNonModule
external fun <T> sorted(a: Array<T>): Boolean

Обратите внимание, что если вы используете CommonJS в качестве целевой платформы, аннотации @JsModule и @JsNonModule необходимо соответствующим образом изменить.

Теперь эту функцию JavaScript можно использовать как обычную функцию Kotlin. Поскольку мы предоставили информацию о типах в заголовочном файле (в отличие от простого определения типа параметров и возвращаемого значения как dynamic), также доступна надлежащая поддержка компилятора и проверка типов.

console.log("Hello, Kotlin/JS!")
console.log(sorted(arrayOf(1,2,3)))
console.log(sorted(arrayOf(3,1,2)))

Выполнив эти три строки в браузере или Node.js, вывод покажет, что вызов sorted был правильно сопоставлен с функцией, экспортированной пакетом is-sorted:

Hello, Kotlin/JS!
true
false

Поскольку в экосистеме JavaScript существует несколько способов экспонирования функций в пакете (например, через именованные или стандартные экспорты), другим пакетам npm может потребоваться немного изменённая структура внешних объявлений.

Чтобы узнать больше о том, как писать объявления, обратитесь к Вызову JavaScript из Kotlin.