NpmTool<TSettings> Class

Summary

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

Syntax

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

Type Parameters

Name Description
TSettings The settings type.

Constructors

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) void
Runs npm.
RunCore(TSettings, ProcessSettings, Action<IProcess>) void
Runs npm.

Extension Methods

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