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

Base class for all npm tools.

Assembly

Cake.Npm.dll

Namespace

Cake.Npm

Base Types

Tool<TSettings>

Derived Types

graph BT Type-->Base0["Tool<TSettings>"] Type["NpmTool<TSettings>"] class Type type-node Derived0["NpmViewVersionTool"]-->Type click Derived0 "/api/Cake.Npm.ViewVersion/NpmViewVersionTool" Derived1["NpmUpdateTool"]-->Type click Derived1 "/api/Cake.Npm.Update/NpmUpdateTool" Derived2["NpmRebuilder"]-->Type click Derived2 "/api/Cake.Npm.Rebuild/NpmRebuilder" Derived3["NpmAddUser"]-->Type click Derived3 "/api/Cake.Npm.AddUser/NpmAddUser" Derived4["NpmPublisher"]-->Type click Derived4 "/api/Cake.Npm.Publish/NpmPublisher" Derived5["NpmVersionTool"]-->Type click Derived5 "/api/Cake.Npm.Version/NpmVersionTool" Derived6["NpmCiTool"]-->Type click Derived6 "/api/Cake.Npm.Ci/NpmCiTool" Derived7["NpmSetTool"]-->Type click Derived7 "/api/Cake.Npm.Set/NpmSetTool" Derived8["NpmPruneRunner"]-->Type click Derived8 "/api/Cake.Npm.Prune/NpmPruneRunner" Derived9["NpmInstaller"]-->Type click Derived9 "/api/Cake.Npm.Install/NpmInstaller" Derived10["NpmPacker"]-->Type click Derived10 "/api/Cake.Npm.Pack/NpmPacker" Derived11["NpmBumpVersionTool"]-->Type click Derived11 "/api/Cake.Npm.BumpVersion/NpmBumpVersionTool" Derived12["NpmScriptRunner"]-->Type click Derived12 "/api/Cake.Npm.RunScript/NpmScriptRunner"

Syntax

public abstract class NpmTool<TSettings> : Tool<TSettings> where TSettings : NpmSettings

Type Parameters

Name	Description
TSettings	The settings type.

Constructors

Name	Summary
NpmTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator, ICakeLog)	Base class for all npm tools.

Properties

Name	Value	Summary
CakeLog	ICakeLog	Cake log instance.

Methods

Name	Value	Summary
GetArguments(TSettings)	ProcessArgumentBuilder	Builds the arguments for npm.
GetToolExecutableNames()	IEnumerable<string>	Gets the possible names of the tool executable.
GetToolName()	string	Gets the name of the tool.
RunCore(TSettings, ProcessSettings, Action<IProcess>)	void	Runs npm.
RunCore(TSettings)	void	Runs npm.

Extension Methods

Name	Value	Summary
Dump<NpmTool<TSettings>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<NpmTool<TSettings>>(NpmTool<TSettings>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<NpmTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<NpmTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<NpmTool<TSettings>>(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<NpmTool<TSettings>>(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