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
Npm tool settings.
- Assembly
- Cake
.Npm .dll - Namespace
- Cake
.Npm - Base Types
-
- ToolSettings
- Derived Types
graph BT
Type-->Base0["ToolSettings"]
Type["NpmSettings"]
class Type type-node
Derived0["NpmInstallSettings"]-->Type
click Derived0 "/api/Cake.Npm.Install/NpmInstallSettings"
Derived1["NpmUpdateSettings"]-->Type
click Derived1 "/api/Cake.Npm.Update/NpmUpdateSettings"
Derived2["NpmPublishSettings"]-->Type
click Derived2 "/api/Cake.Npm.Publish/NpmPublishSettings"
Derived3["NpmBumpVersionSettings"]-->Type
click Derived3 "/api/Cake.Npm.BumpVersion/NpmBumpVersionSettings"
Derived4["NpmPruneSettings"]-->Type
click Derived4 "/api/Cake.Npm.Prune/NpmPruneSettings"
Derived5["NpmCiSettings"]-->Type
click Derived5 "/api/Cake.Npm.Ci/NpmCiSettings"
Derived6["NpmAddUserSettings"]-->Type
click Derived6 "/api/Cake.Npm.AddUser/NpmAddUserSettings"
Derived7["NpmPackSettings"]-->Type
click Derived7 "/api/Cake.Npm.Pack/NpmPackSettings"
Derived8["NpmRunScriptSettings"]-->Type
click Derived8 "/api/Cake.Npm.RunScript/NpmRunScriptSettings"
Derived9["NpmViewVersionSettings"]-->Type
click Derived9 "/api/Cake.Npm.ViewVersion/NpmViewVersionSettings"
Derived10["NpmSetSettings"]-->Type
click Derived10 "/api/Cake.Npm.Set/NpmSetSettings"
Derived11["NpmVersionSettings"]-->Type
click Derived11 "/api/Cake.Npm.Version/NpmVersionSettings"
Derived12["NpmRebuildSettings"]-->Type
click Derived12 "/api/Cake.Npm.Rebuild/NpmRebuildSettings"
Syntax
public abstract class NpmSettings : ToolSettingsConstructors
| Name | Summary |
|---|---|
| NpmSettings |
Initializes a new instance of the NpmSettings class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| Command | string |
Gets the command which should be run.
|
| LogLevel | NpmLogLevel |
Gets or sets the log level which should be used to run the npm command.
|
| Redirect |
bool |
Gets or sets the process option to redirect standard error output.
|
| Redirect |
bool |
Gets or sets the process option to redirect standard output.
|
| StandardErrorAction | Action |
Gets or sets an action to retrieve and process standard error output.
|
| StandardOutputAction | Action |
Gets or sets an action to retrieve and process standard output.
|
Methods
| Name | Value | Summary |
|---|---|---|
| EvaluateCore |
void |
Evaluates the settings and writes them to args.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| FromPath |
NpmSettings |
Sets the working directory which should be used to run the npm command.
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 |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues 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
|
| WithLogLevel |
NpmSettings |
Sets the log level which should be used to run the npm command.
Requires the Cake.Npm addin
|