ns-scripting-core/net.democritus.scripting.npm

Package-level declarations

Types

interface NpmInstallExecutionTemplate : ExecutionTemplate

The ExecutionTemplate which is created using the install execution builder function. This template class is used as a builder to construct the arguments for installing a project with NPM.

NpmRunExecutionTemplate

interface NpmRunExecutionTemplate : ExecutionTemplate

The ExecutionTemplate which is created using the run execution builder function. This template class is used as a builder to construct the arguments for running a script with NPM.

NpmScope

interface NpmScope : ScriptScope

This scoping object is created by the ScriptScope.npm function. Its purpose is providing access to functionality such as execution functions that can run NPM scripts.

Functions

install

fun NpmScope.install(body: NpmInstallExecutionTemplate.() -> Unit)

This execution function is used to run an NPM install operation, which installs a package/project from a package.json file. The body parameter is supplied as a higher-order function that executes within the scope of an NpmInstallExecutionTemplate object, in which the parameters for the installation process can be declared.

npm

fun ScriptScope.npm(body: NpmScope.() -> Unit)

A scoping function to execute a code block within the context of an NpmScope instance, which provides functionality to execute NPM commands.

run

fun NpmScope.run(body: NpmRunExecutionTemplate.() -> Unit)

This execution function is used to run an NPM run operation, which runs a script as defined in a package.json file. The body parameter is supplied as a higher-order function that executes within the scope of an NpmRunExecutionTemplate object, in which the parameters for the script execution can be declared.