NodeJsToolchainService

Provisions Node.js distributions for the Kotlin Gradle Plugin.

The service accepts a NodeJsRequest - a description of the desired Node.js distribution - and returns a Provider of a NodeJsExecutable that, when evaluated, points to a complete, provisioned installation.

An implementation decides entirely how to satisfy the request: download the distribution, reuse an already existing installation, or use node from the PATH.

The service is realized as a shared BuildService, so a single instance is used by the whole build, and provisioning is safe with Gradle Isolated Projects, the configuration cache, and parallel execution.

This is a part of the Kotlin Gradle Plugin public API - external users may provide their own implementation. The Kotlin Gradle Plugin uses exactly one service, and ships the following built-in implementations:

• DefaultNodeJsToolchainService - downloads the official Node.js distribution.

• PreInstalledNodeJsToolchainService - uses node available on the PATH.

A custom implementation may delegate to one of the built-in ones.

Type Parameters

Inheritors