Использование зависимостей из 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, который предлагает только одну функцию, это объявление будет небольшим. Внутри папки source создайте новый файл с именем 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.