NpmCiSettings Class

Summary

Contains settings used by NpmCiTool.
Assembly
Cake.Npm.dll
Namespace
Cake.Npm.Ci
Base Types
graph BT Type-->Base0["NpmSettings"] click Base0 "/api/Cake.Npm/NpmSettings" Base0-->Base1["ToolSettings"] Type["NpmCiSettings"] class Type type-node

Syntax

public class NpmCiSettings : NpmSettings

Constructors

Name Summary
NpmCiSettings() Initializes a new instance of the NpmCiSettings class.

Properties

Name Value Summary
Command string
Gets the command which should be run.
Inherited from NpmSettings
LogLevel NpmLogLevel
Gets or sets the log level which should be used to run the npm command.
Inherited from NpmSettings
Production bool
Gets a value indicating whether npm should ignore modules listed in
devDependencies
.
RedirectStandardError bool
Gets or sets the process option to redirect standard error
Inherited from NpmSettings
RedirectStandardOutput bool
Gets or sets the process option to redirect standard output
Inherited from NpmSettings
Registry Uri
Gets or sets the registry where packages should be restored from. Defaulted to whatever the NPM configuration is.

Methods

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

Extension Methods

Name Value Summary
Dump<NpmCiSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
ForProduction() NpmCiSettings
Defines that npm should ignore modules listed in devDependencies.
Requires the Cake.Npm addin
FromPath(DirectoryPath) NpmSettings
Sets the working directory which should be used to run the npm command.
Requires the Cake.Npm addin
FromRegistry(Uri) NpmCiSettings
Instructs npm to look for packages in the given registry.
Requires the Cake.Npm addin
IsIn<NpmCiSettings>(NpmCiSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NpmCiSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NpmCiSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<NpmCiSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<NpmCiSettings>(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
WithLogLevel(NpmLogLevel) NpmSettings
Sets the log level which should be used to run the npm command.
Requires the Cake.Npm addin