This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Npm.
Summary
Contains settings used by
NpmInstaller.
- Assembly
- Cake
.Npm .dll - Namespace
- Cake
.Npm .Install - Base Types
-
- ToolSettings
- NpmSettings
graph BT
Type-->Base0["NpmSettings"]
click Base0 "/api/Cake.Npm/NpmSettings"
Base0-->Base1["ToolSettings"]
Type["NpmInstallSettings"]
class Type type-node
Syntax
public class NpmInstallSettings : NpmSettingsConstructors
| Name | Summary |
|---|---|
| NpmInstallSettings |
Initializes a new instance of the NpmInstallSettings class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| Command | string |
Gets the command which should be run.
Inherited from NpmSettings
|
| Force | bool |
Gets a value indicating whether npm should fetch remote resources even if a local copy
exists on disk.
|
| Global | bool |
Gets a value indicating whether the package should be installed globally rather than locally.
|
| LogLevel | NpmLogLevel |
Gets or sets the log level which should be used to run the npm command.
Inherited from NpmSettings
|
| NoOptional | bool |
Gets a value indicating whether npm should prevent optional dependencies from being installed
(the --no-optional argument)
|
| Packages | IList |
Gets the list of packages which should be installed.
|
| PreferOffline | bool |
Gets or sets a value indicating whether or not to utilise the prefer offline flag, avoiding going to the internet for packages if possible.
|
| Production | bool |
Gets a value indicating whether npm should ignore modules listed in
|
| Redirect |
bool |
Gets or sets the process option to redirect standard error output.
Inherited from NpmSettings
|
| Redirect |
bool |
Gets or sets the process option to redirect standard output.
Inherited from NpmSettings
|
| Registry | Uri |
Gets or sets a value indicating which registry we should point to. Defaulted to whatever the NPM configuration is.
|
| StandardErrorAction | Action |
Gets or sets an action to retrieve and process standard error output.
Inherited from NpmSettings
|
| StandardOutputAction | Action |
Gets or sets an action to retrieve and process standard output.
Inherited from NpmSettings
|
Methods
| Name | Value | Summary |
|---|---|---|
| EvaluateCore |
void |
Evaluates the settings and writes them to args.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| AddPackage |
NpmInstallSettings |
Install a package by name, version/tag and scope.
Requires the Cake.Npm addin
|
| AddPackage |
NpmInstallSettings |
Install a package by name and version/tag.
Requires the Cake.Npm addin
|
| AddPackage |
NpmInstallSettings |
Install a package by name, version/tag.
Requires the Cake.Npm addin
|
| AddPackage |
NpmInstallSettings |
Install a package from a specific url.
Requires the Cake.Npm addin
|
| AddScopedPackage |
NpmInstallSettings |
Install a scoped package by name, version/tag.
Requires the Cake.Npm addin
|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| ForProduction |
NpmInstallSettings |
Defines that npm should ignore modules listed in
devDependencies.
Requires the Cake.Npm addin
|
| FromPath |
NpmSettings |
Sets the working directory which should be used to run the npm command.
Requires the Cake.Npm addin
|
| FromRegistry |
NpmInstallSettings |
Instructs npm to look for packages in the given registry.
Requires the Cake.Npm addin
|
| InstallGlobally |
NpmInstallSettings |
Defines that the package should be installed globally.
Requires the Cake.Npm addin
|
| InstallLocally |
NpmInstallSettings |
Defines that the package should be installed locally.
Requires the Cake.Npm addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| Set |
NpmSettings |
Sets the StandardError-Action
Requires the Cake.Npm addin
|
| Set |
NpmSettings |
Sets the StandardOutput-Action
Requires the Cake.Npm addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
From StringExtensions
Requires the Cake.Issues addin
|
| WithForce |
NpmInstallSettings |
Defines whether npm should fetch remote resources even if a local copy
exists on disk.
Requires the Cake.Npm addin
|
| WithForce |
NpmInstallSettings |
Defines that npm should fetch remote resources even if a local copy
exists on disk.
Requires the Cake.Npm addin
|
| WithLogLevel |
NpmSettings |
Sets the log level which should be used to run the npm command.
Requires the Cake.Npm addin
|
| WithNoOptional |
NpmInstallSettings |
Defines whether npm should prevent optional dependencies from being installed
Requires the Cake.Npm addin
|
| With |
NpmInstallSettings |
Defines that npm should install optional dependencies
Requires the Cake.Npm addin
|
| WithoutForce |
NpmInstallSettings |
Defines that npm should not fetch remote resources if a local copy exists on disk.
Requires the Cake.Npm addin
|
| Without |
NpmInstallSettings |
Defines that npm should prevent optional dependencies from being installed
Requires the Cake.Npm addin
|