NodeJSExtension (nodejs-gradle-plugin 2.0.0 API)

org.ysb33r.gradle.nodejs.NodeJSExtension

All Implemented Interfaces and Traits:

org.ysb33r.grolifant.api.core.runnable.ProvisionedExecMethods
```
@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class NodeJSExtension
extends BaseNodeJSExtension
```
Configure project defaults or task specifics for Node.js.
Since:
0.1

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`NAME`
`static java.lang.String`	`NODEJS_DEFAULT`	The default version of Node.js that will be used on a supported platform if nothing else is configured.

Inherited fields
Fields inherited from class	Fields
`class BaseNodeJSExtension`	`NODEJS_DEFAULT, locateNpm`

Constructor Summary

Constructors
Constructor and description
`NodeJSExtension (org.gradle.api.Project project)` Constructs a new extension which is attached to the provided project.
`NodeJSExtension (org.gradle.api.Task task)` Constructs a new extension which is attached to the provided task.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`NodeJSExecSpec`	`createExecSpec()` Create execution specification.
	`void`	`executableByNvmRc(org.gradle.api.provider.Provider<java.io.File> nvmrc)` Read the version from `.nvmrc`.
	`void`	`executableByNvmrc()` Read the version from `.nvmrc`.
	`void`	`executableByPath(java.lang.Object path)` Locate an executable by a local path.
	`void`	`executableBySearchPath(java.lang.Object baseName)` Locate executable by searching the current environmental search path.
	`void`	`executableByVersion(java.lang.Object version)` Locate an executable by version, probably downloading it if not local.
	`org.gradle.api.provider.Provider<java.io.File>`	`getNvmrcLocation()` `.nvmrc` location.
	`boolean`	`isResolveNodeByVersion()` Indicates whether resolving `node` is by version.
	`boolean`	`isSyncNodeVersionFromNvmRc()` Indicates whether the Node version is being syncronised from `.nvmrc`.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class BaseNodeJSExtension`	`appendPath, environment, getDownloader, getEnvironment, getNpmCliJsProvider, prefixPath, runExecutableAndReturnVersion, setEnvironment, useSystemPath`

- Field Detail
  - public static final java.lang.String NAME
  - public static final java.lang.String NODEJS_DEFAULT
    
    The default version of Node.js that will be used on a supported platform if nothing else is configured.
- Constructor Detail
  - NodeJSExtension(org.gradle.api.Project project)
    
    Constructs a new extension which is attached to the provided project.
    Parameters:
    project - Project this extension is associated with.
  - NodeJSExtension(org.gradle.api.Task task)
    
    Constructs a new extension which is attached to the provided task.
    Parameters:
    project - Project this extension is associated with.
- Method Detail
  - @java.lang.Override NodeJSExecSpec createExecSpec()
    
    Create execution specification.
    Returns:
    Execution specification.
    Since:
    0.10
  - @java.lang.SuppressWarnings('CatchArrayIndexOutOfBoundsException') void executableByNvmRc(org.gradle.api.provider.Provider<java.io.File> nvmrc)
    
    Read the version from .nvmrc. Only supports fixed versions, not open versions like node or lts/*.
    Parameters:
    nvmrc - Provider to the location of .nvmrc
    Since:
    0.11
  - void executableByNvmrc()
    
    Read the version from .nvmrc. Only supports fixed versions, not open versions like node or lts/*. Assumes .nvmrc is at the npm homedirectory
    Since:
    0.11
  - @java.lang.Override void executableByPath(java.lang.Object path)
    
    Locate an executable by a local path.
    Parameters:
    path - Something resolvable to a java.io.File.
  - @java.lang.Override void executableBySearchPath(java.lang.Object baseName)
    
    Locate executable by searching the current environmental search path.
    Parameters:
    baseName - The base name of the executable
  - @java.lang.Override void executableByVersion(java.lang.Object version)
    
    Locate an executable by version, probably downloading it if not local.
    Parameters:
    version - Something resolvable to a string.
  - org.gradle.api.provider.Provider<java.io.File> getNvmrcLocation()
    
    .nvmrc location.
    Returns:
    Location of .nvmrc. Can be a null provider.
    Since:
    2.0
  - boolean isResolveNodeByVersion()
    
    Indicates whether resolving node is by version.
    Returns:
    true if the version has been set.
  - boolean isSyncNodeVersionFromNvmRc()
    
    Indicates whether the Node version is being syncronised from .nvmrc.
    Returns:
    true us linkage has been established.

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class NodeJSExtension

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String NAME

public static final java.lang.String NODEJS_DEFAULT

Constructor Detail

NodeJSExtension(org.gradle.api.Project project)

NodeJSExtension(org.gradle.api.Task task)

Method Detail

@java.lang.Override NodeJSExecSpec createExecSpec()

@java.lang.SuppressWarnings('CatchArrayIndexOutOfBoundsException') void executableByNvmRc(org.gradle.api.provider.Provider<java.io.File> nvmrc)

void executableByNvmrc()

@java.lang.Override void executableByPath(java.lang.Object path)

@java.lang.Override void executableBySearchPath(java.lang.Object baseName)

@java.lang.Override void executableByVersion(java.lang.Object version)

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

boolean isResolveNodeByVersion()

boolean isSyncNodeVersionFromNvmRc()