NpmSettings Class

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["NpmExecSettings"]-->Type click Derived0 "/api/Cake.Npm.Exec/NpmExecSettings" Derived1["NpmCiSettings"]-->Type click Derived1 "/api/Cake.Npm.Ci/NpmCiSettings" Derived2["NpmSetSettings"]-->Type click Derived2 "/api/Cake.Npm.Set/NpmSetSettings" Derived3["NpmRebuildSettings"]-->Type click Derived3 "/api/Cake.Npm.Rebuild/NpmRebuildSettings" Derived4["NpmVersionSettings"]-->Type click Derived4 "/api/Cake.Npm.Version/NpmVersionSettings" Derived5["NpmRunScriptSettings"]-->Type click Derived5 "/api/Cake.Npm.RunScript/NpmRunScriptSettings" Derived6["NpmPruneSettings"]-->Type click Derived6 "/api/Cake.Npm.Prune/NpmPruneSettings" Derived7["NpmPublishSettings"]-->Type click Derived7 "/api/Cake.Npm.Publish/NpmPublishSettings" Derived8["NpmViewVersionSettings"]-->Type click Derived8 "/api/Cake.Npm.ViewVersion/NpmViewVersionSettings" Derived9["NpmInstallSettings"]-->Type click Derived9 "/api/Cake.Npm.Install/NpmInstallSettings" Derived10["NpmAddUserSettings"]-->Type click Derived10 "/api/Cake.Npm.AddUser/NpmAddUserSettings" Derived11["NpmUpdateSettings"]-->Type click Derived11 "/api/Cake.Npm.Update/NpmUpdateSettings" Derived12["NpmPackSettings"]-->Type click Derived12 "/api/Cake.Npm.Pack/NpmPackSettings" Derived13["NpmBumpVersionSettings"]-->Type click Derived13 "/api/Cake.Npm.BumpVersion/NpmBumpVersionSettings"

Syntax

public abstract class NpmSettings : ToolSettings

Constructors

Name Summary
NpmSettings(string) Npm tool settings.

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.
RedirectStandardError bool
Gets or sets the process option to redirect standard error output.
RedirectStandardOutput bool
Gets or sets the process option to redirect standard output.
StandardErrorAction Action<string>
Gets or sets an action to retrieve and process standard error output.
StandardOutputAction Action<string>
Gets or sets an action to retrieve and process standard output.

Methods

Name Value Summary
EvaluateCore(ProcessArgumentBuilder) void
Evaluates the settings and writes them to args.

Extension Methods

Name Value Summary
Dump<NpmSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
FromPath(DirectoryPath) NpmSettings
Sets the working directory which should be used to run the npm command.
Requires the Cake.Npm addin
IsIn<NpmSettings>(NpmSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NpmSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NpmSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
SetRedirectedStandardErrorHandler(Action<string>) NpmSettings
Sets the StandardError-Action
Requires the Cake.Npm addin
SetRedirectedStandardOutputHandler(Action<string>) NpmSettings
Sets the StandardOutput-Action
Requires the Cake.Npm addin
ThrowIfNull<NpmSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<NpmSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin
WithLogLevel(NpmLogLevel) NpmSettings
Sets the log level which should be used to run the npm command.
Requires the Cake.Npm addin