kotlin-gradle-plugin-api/org.jetbrains.kotlin.gradle.plugin/KotlinDependencyHandler/optionalNpm

optionalNpm

abstract fun optionalNpm(name: String, version: String): Dependency

Creates a dependency to a NPM module that is added to optionalDependencies.

Note: The created dependency should be manually added to this entity using other methods from this DSL:

kotlin.sourceSets["jsMain"].dependencies {
    implementation(optionalNpm("is-odd-even", "1.0.0"))
}

This is only relevant for Kotlin entities that target only KotlinPlatformType.js or KotlinPlatformType.wasm.

Parameters

name

The NPM dependency name

version

The NPM dependency version

abstract fun optionalNpm(name: String, directory: File): Dependency

Creates a dependency to a NPM module that is added to optionalDependencies.

Note: The created dependency should be manually added to this entity using other methods from this DSL:

kotlin.sourceSets["jsMain"].dependencies {
    implementation(optionalNpm("is-odd-even", project.file("npm/is-odd-even")))
}

Note: Only relevant for Kotlin entities targeting only KotlinPlatformType.js or KotlinPlatformType.wasm!

Parameters

name

The NPM dependency name

directory

The directory where dependency files are located (See NPM directory keyword)

abstract fun optionalNpm(directory: File): Dependency

Creates a dependency to a NPM module that is added to optionalDependencies. The name of the dependency is derived either from the package.json file located in the directory or the directory name itself.

Note: The created dependency should be manually added to this entity using other methods from this DSL:

kotlin.sourceSets["jsMain"].dependencies {
    implementation(optionalNpm(project.file("npm/is-odd-even")))
}

This is only relevant for Kotlin entities that target only KotlinPlatformType.js or KotlinPlatformType.wasm.