org.ysb33r.gradle.nodejs

Interface NodeJSExtensionMethods

public interface NodeJSExtensionMethods

NodeJS methods that an extension should implement.

Since:

2.1

Method Summary

Modifier and Type	Method and Description
void	appendPath(org.gradle.api.provider.Provider<java.lang.String> postfix) Add search to system path.
void	environment(java.util.Map<java.lang.String,?> args) Add environmental variables to be passed to the exe.
java.util.Map<java.lang.String,java.lang.String>	getEnvironment() Environment for running the exe
org.gradle.api.provider.Provider<java.io.File>	getExecutable() A provider for a resolved executable.
org.gradle.api.provider.Provider<java.io.File>	getNpmCliJsProvider() Resolves a path to a npm executable that is associated with the configured Node.js.
void	prefixPath(org.gradle.api.provider.Provider<java.lang.String> prefix) Add search to system path In the case of a task this will be prefixed to both the task and project extension's version of the system path.
void	setEnvironment(java.util.Map<java.lang.String,?> args) Replaces current environment with new one.
void	useSystemPath() Adds the system path to the execution environment.

Method Detail

getExecutable

org.gradle.api.provider.Provider<java.io.File> getExecutable()

A provider for a resolved executable.

Returns:

File provider.

getNpmCliJsProvider

org.gradle.api.provider.Provider<java.io.File> getNpmCliJsProvider()

Resolves a path to a npm executable that is associated with the configured Node.js.

Returns:

Returns the path to the located npm executable.

setEnvironment

void setEnvironment(java.util.Map<java.lang.String,?> args)

Replaces current environment with new one. If this is called on the task extension, no project extension environment will be used.

Parameters:

args - New environment key-value map of properties.

getEnvironment

java.util.Map<java.lang.String,java.lang.String> getEnvironment()

Environment for running the exe

Calling this will resolve all lazy-values in the variable map.

Returns:

Map of environmental variables that will be passed.

environment

void environment(java.util.Map<java.lang.String,?> args)

Add environmental variables to be passed to the exe.

Parameters:

args - Environmental variable key-value map.

useSystemPath

void useSystemPath()

Adds the system path to the execution environment.

appendPath

void appendPath(org.gradle.api.provider.Provider<java.lang.String> postfix)

Add search to system path. In the case of a task this will be appended to both the task and project extension's version of the system path.

Parameters:

postfix - Provider of a path item that can be appended to the current system path.

prefixPath

void prefixPath(org.gradle.api.provider.Provider<java.lang.String> prefix)

Add search to system path In the case of a task this will be prefixed to both the task and project extension's version of the system path.

Parameters:

prefix - Provider of a path item that can be prefixed to the current system path.