PnpmSettings Class

Summary

Pnpm tool settings.
graph BT Type-->Base0["ToolSettings"] Type["PnpmSettings"] class Type type-node Derived0["PnpmListSettings"]-->Type click Derived0 "/api/Cake.Pnpm.List/PnpmListSettings" Derived1["PnpmAddSettings"]-->Type click Derived1 "/api/Cake.Pnpm.Add/PnpmAddSettings" Derived2["PnpmLinkSettings"]-->Type click Derived2 "/api/Cake.Pnpm.Link/PnpmLinkSettings" Derived3["PnpmRemoveSettings"]-->Type click Derived3 "/api/Cake.Pnpm.Remove/PnpmRemoveSettings" Derived4["PnpmUpdateSettings"]-->Type click Derived4 "/api/Cake.Pnpm.Update/PnpmUpdateSettings" Derived5["PnpmImportSettings"]-->Type click Derived5 "/api/Cake.Pnpm.Import/PnpmImportSettings" Derived6["PnpmUnlinkSettings"]-->Type click Derived6 "/api/Cake.Pnpm.Unlink/PnpmUnlinkSettings" Derived7["PnpmAuditSettings"]-->Type click Derived7 "/api/Cake.Pnpm.Audit/PnpmAuditSettings" Derived8["PnpmPruneSettings"]-->Type click Derived8 "/api/Cake.Pnpm.Prune/PnpmPruneSettings" Derived9["PnpmInstallSettings"]-->Type click Derived9 "/api/Cake.Pnpm.Install/PnpmInstallSettings" Derived10["PnpmRebuildSettings"]-->Type click Derived10 "/api/Cake.Pnpm.Rebuild/PnpmRebuildSettings" Derived11["PnpmLicensesSettings"]-->Type click Derived11 "/api/Cake.Pnpm.Licenses/PnpmLicensesSettings" Derived12["PnpmOutdatedSettings"]-->Type click Derived12 "/api/Cake.Pnpm.Outdated/PnpmOutdatedSettings" Derived13["PnpmStoreSettings"]-->Type click Derived13 "/api/Cake.Pnpm.Store/PnpmStoreSettings" Derived14["PnpmRunSettings"]-->Type click Derived14 "/api/Cake.Pnpm.Run/PnpmRunSettings" Derived15["PnpmExecSettings"]-->Type click Derived15 "/api/Cake.Pnpm.Exec/PnpmExecSettings"

Syntax

public abstract class PnpmSettings : ToolSettings

Constructors

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

Properties

Name Value Summary
CakeVerbosityLevel Nullable<Verbosity>
Gets or sets the Log level set by Cake.
PnpmLogLevel PnpmLogLevel
What level of logs to report. Any logs at or higher than the given level will be shown. Levels (lowest to highest): debug, info, warn, error.
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<PnpmSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<PnpmSettings>(PnpmSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<PnpmSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<PnpmSettings>(string) void
Requires the Cake.Issues addin
ThrowIfNull<PnpmSettings>(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<PnpmSettings>(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
Requires the Cake.Issues addin