NpmPruneSettings Class

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 NpmPruneRunner.

Assembly

Namespace

Base Types

ToolSettings
NpmSettings

graph BT Type-->Base0["NpmSettings"] click Base0 "/api/Cake.Npm/NpmSettings" Base0-->Base1["ToolSettings"] Type["NpmPruneSettings"] class Type type-node

Syntax

public class NpmPruneSettings : NpmSettings

Constructors

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

Properties

Name	Value	Summary
Command	string	Gets the command which should be run. Inherited from NpmSettings
DryRun	bool	If true, then no changes will actually be made.
Json	bool	If true, then the changes npm prune made (or would have made with DryRun) are printed as a JSON object.
LogLevel	NpmLogLevel	Gets or sets the log level which should be used to run the npm command. Inherited from NpmSettings
Packages	IList<string>	If a package name is added, then only packages matching one of the supplied names are removed.
Production	bool	Whether npm should remove modules listed in `devDependencies` .
RedirectStandardError	bool	Gets or sets the process option to redirect standard error output. Inherited from NpmSettings
RedirectStandardOutput	bool	Gets or sets the process option to redirect standard output. Inherited from NpmSettings
StandardErrorAction	Action<string>	Gets or sets an action to retrieve and process standard error output. Inherited from NpmSettings
StandardOutputAction	Action<string>	Gets or sets an action to retrieve and process standard output. Inherited from NpmSettings

Methods

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

Extension Methods

Name	Value	Summary
AddPackage(string, string)	NpmPruneSettings	If a package name is added, then only packages matching one of the supplied names are removed. From NpmPruneSettingsExtensions Requires the Cake.Npm addin
AddPackage(string)	NpmPruneSettings	If a package name is added, then only packages matching one of the supplied names are removed. From NpmPruneSettingsExtensions Requires the Cake.Npm addin
DryRun(bool)	NpmPruneSettings	If true, then no changes will actually be made. From NpmPruneSettingsExtensions Requires the Cake.Npm addin
DryRun()	NpmPruneSettings	Set so no changes will actually be made. From NpmPruneSettingsExtensions Requires the Cake.Npm addin
Dump<NpmPruneSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
ForProduction(bool)	NpmPruneSettings	Defines whether npm should remove modules listed in `devDependencies`. From NpmPruneSettingsExtensions Requires the Cake.Npm addin
ForProduction()	NpmPruneSettings	Defines that npm should remove modules listed in `devDependencies`. From NpmPruneSettingsExtensions Requires the Cake.Npm addin
FromPath(DirectoryPath)	NpmSettings	Sets the working directory which should be used to run the npm command. From NpmSettingsExtensions Requires the Cake.Npm addin
IsIn<NpmPruneSettings>(NpmPruneSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
Json(bool)	NpmPruneSettings	If true, the changes npm prune made (or would have made with DryRun) are printed as a JSON object. From NpmPruneSettingsExtensions Requires the Cake.Npm addin
Json()	NpmPruneSettings	The changes npm prune made (or would have made with DryRun) are printed as a JSON object. From NpmPruneSettingsExtensions Requires the Cake.Npm addin
NotNull<NpmPruneSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<NpmPruneSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
SetRedirectedStandardErrorHandler(Action<string>)	NpmSettings	Sets the StandardError-Action From NpmSettingsExtensions Requires the Cake.Npm addin
SetRedirectedStandardOutputHandler(Action<string>)	NpmSettings	Sets the StandardOutput-Action From NpmSettingsExtensions Requires the Cake.Npm addin
ThrowIfNull<NpmPruneSettings>(string, string)	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<NpmPruneSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin
WithLogLevel(NpmLogLevel)	NpmSettings	Sets the log level which should be used to run the npm command. From NpmSettingsExtensions Requires the Cake.Npm addin