NpmExtensionMethods (nodejs-gradle-plugin 2.2.1 API)

```
public interface NpmExtensionMethods
```
Methods than Npm extension is required to implement.

Since:

2.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NpmExecSpec`	`createExecSpec()` Create execution specification.
`void`	`executableIsBundled()` Use the NPM that is bundled with Node.
`org.gradle.api.provider.Provider<java.io.File>`	`getExecutable()` A provider for a resolved executable.
`java.io.File`	`getGlobalConfig()` Location and name of global NPM config file.
`java.io.File`	`getHomeDirectory()` The NPM home directory - the parent directory of `node_modules`,
`org.gradle.api.provider.Provider<java.io.File>`	`getHomeDirectoryProvider()` The NPM home directory - the parent directory of `node_modules`,
`java.io.File`	`getLocalConfig()` Location and name of local NPM config file.
`org.gradle.api.provider.Provider<java.io.File>`	`getNpxCliJsProvider()` The location of NPX.
`org.gradle.api.provider.Provider<java.io.File>`	`getProjectConfig()` Location of `.npmrc` for a project.
`org.gradle.api.provider.Provider<java.lang.String>`	`getVersionProvider()` Provides the version as specified in `package.json`.
`void`	`globalConfig(java.lang.Object path)` Sets global config file.
`void`	`homeDirectory(java.lang.Object homeDir)` Sets the home directory.
`void`	`localConfig(java.lang.Object path)` Sets local config file.
`void`	`setGlobalConfig(java.lang.Object path)` Sets global config file.
`void`	`setHomeDirectory(java.lang.Object homeDir)` Sets the home directory.
`void`	`setLocalConfig(java.lang.Object path)` Sets local config file.
`org.gradle.api.provider.Provider<java.io.File>`	`useGlobalGradleLocation()` Sets it to use the equivalent of `getGradleHomeDir()/.npmrc`.
`org.gradle.api.provider.Provider<java.io.File>`	`useGlobalSystemLocation()` Tries to determine the location where global config will typically be places.
`org.gradle.api.provider.Provider<java.io.File>`	`useLocalProjectLocation()` Use to indicate that userconfig should be retrieved from the NPM home directory as configured by `getHomeDirectory()`.
`org.gradle.api.provider.Provider<java.io.File>`	`useLocalUserProfileLocation()` Use to indicate that userconfig should be retrieved from the user's home directory.
`void`	`usePackageJsonVersionAsProjectVersion()` Use the version specified in `package.json` as the version of the project.

- Method Detail
  - executableIsBundled
```
void executableIsBundled()
```
    Use the NPM that is bundled with Node.
    This is the default and should rarely be required.
  - getExecutable
```
org.gradle.api.provider.Provider<java.io.File> getExecutable()
```
    A provider for a resolved executable.
    
    Returns:
    
    File provider.
  - getNpxCliJsProvider
```
org.gradle.api.provider.Provider<java.io.File> getNpxCliJsProvider()
```
    The location of NPX.
    
    Returns:
    
    A provider to the location of NPX
  - createExecSpec
```
NpmExecSpec createExecSpec()
```
    Create execution specification.
    
    Returns:
    
    Execution specification.
  - getGlobalConfig
```
java.io.File getGlobalConfig()
```
    Location and name of global NPM config file. When this extension is attached to a project, the default location is set to "${project.gradle.gradleUserHomeDir}/npmrc"
    
    Returns:
    
    File object pointing to global NPM config
  - setGlobalConfig
```
void setGlobalConfig(java.lang.Object path)
```
    Sets global config file.
    
    Parameters:
    
    path - Anything that can be converted using project.file.
  - globalConfig
```
void globalConfig(java.lang.Object path)
```
    Sets global config file.
    
    Parameters:
    
    path - Anything that can be converted using project.file.
  - getLocalConfig
```
java.io.File getLocalConfig()
```
    Location and name of local NPM config file. When this extension is attached to a project, the default location is set to "${project.rootProject.projectDir}/npmrc"
    
    Returns:
    
    File object pointing to local NPM config
  - getProjectConfig
```
org.gradle.api.provider.Provider<java.io.File> getProjectConfig()
```
    Location of .npmrc for a project.
    
    Returns:
    
    Project config level.
  - setLocalConfig
```
void setLocalConfig(java.lang.Object path)
```
    Sets local config file.
    
    Parameters:
    
    path - Anything that can be converted using project.file.
  - localConfig
```
void localConfig(java.lang.Object path)
```
    Sets local config file.
    
    Parameters:
    
    path - Anything that can be converted using project.file.
  - getHomeDirectory
```
java.io.File getHomeDirectory()
```
    The NPM home directory - the parent directory of node_modules,
    
    Returns:
    
    Parent directory of node_modules. Never null if the extension is tied to a project, in which case it defaults to project.projectDir.
  - getHomeDirectoryProvider
```
org.gradle.api.provider.Provider<java.io.File> getHomeDirectoryProvider()
```
    The NPM home directory - the parent directory of node_modules,
    
    Returns:
    
    Parent directory of node_modules. Never null if the extension is tied to a project, in which case it defaults to project.projectDir.
  - getVersionProvider
```
org.gradle.api.provider.Provider<java.lang.String> getVersionProvider()
```
    Provides the version as specified in package.json.
    
    Returns:
    
    Version provider.
  - setHomeDirectory
```
void setHomeDirectory(java.lang.Object homeDir)
```
    Sets the home directory.
    
    Parameters:
    
    homeDir - A directory in which node_modules will be created as a child folder. Anything that can be resolved with project.file is acceptable
  - homeDirectory
```
void homeDirectory(java.lang.Object homeDir)
```
    Sets the home directory.
    
    Parameters:
    
    homeDir - A directory in which node_modules will be created as a child folder. Anything that can be resolved with project.file is acceptable
  - useGlobalSystemLocation
```
org.gradle.api.provider.Provider<java.io.File> useGlobalSystemLocation()
```
    Tries to determine the location where global config will typically be places.
    
    Returns:
    
    A provider to a system location.
  - useGlobalGradleLocation
```
org.gradle.api.provider.Provider<java.io.File> useGlobalGradleLocation()
```
    Sets it to use the equivalent of getGradleHomeDir()/.npmrc.
    This allows Gradle projects to be custom configured on local system without being affected by any system-wide node installations.
    
    Returns:
    
    Location of a global configuration file for NPM that is located inside the Gradle home directory.
  - useLocalUserProfileLocation
```
org.gradle.api.provider.Provider<java.io.File> useLocalUserProfileLocation()
```
    Use to indicate that userconfig should be retrieved from the user's home directory.
    Typically this is ~/.npmrc or %APPDATA\npm\.npmrc
    
    Returns:
    
    Location for a userconfig .npmrc
  - useLocalProjectLocation
```
org.gradle.api.provider.Provider<java.io.File> useLocalProjectLocation()
```
    Use to indicate that userconfig should be retrieved from the NPM home directory as configured by getHomeDirectory().
    
    Returns:
    
    Location for a userconfig .npmrc
  - usePackageJsonVersionAsProjectVersion
```
void usePackageJsonVersionAsProjectVersion()
```
    Use the version specified in package.json as the version of the project.
    If package.json does not exist, then undefined is used as the version.

Interface NpmExtensionMethods

Method Summary

Method Detail

executableIsBundled

getExecutable

getNpxCliJsProvider

createExecSpec

getGlobalConfig

setGlobalConfig

globalConfig

getLocalConfig

getProjectConfig

setLocalConfig

localConfig

getHomeDirectory

getHomeDirectoryProvider

getVersionProvider

setHomeDirectory

homeDirectory

useGlobalSystemLocation

useGlobalGradleLocation

useLocalUserProfileLocation

useLocalProjectLocation

usePackageJsonVersionAsProjectVersion