NpmPublishSettings Class

Summary

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

Syntax

public class NpmPublishSettings : NpmSettings

Constructors

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

Properties

Name Value Summary
Access NpmPublishAccess
Gets or sets whether the package should be published as public or restricted.
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
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
Registry Uri
Gets or sets the registry where the package should be published to. Defaulted to whatever the NPM configuration is.
Source string
Gets or sets the source to publish. A folder containing a package.json file or an url or file path to a gzipped tar archive containing a single folder with a package.json file inside.
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
Tag string
Gets or sets the tag with which the package will be published. By default the latest tag is used.

Methods

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

Extension Methods

Name Value Summary
Dump<NpmPublishSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
FromPath(DirectoryPath) NpmSettings
Sets the working directory which should be used to run the npm command.
Requires the Cake.Npm addin
FromSource(string) NpmPublishSettings
Sets the source to publish.
Requires the Cake.Npm addin
IsIn<NpmPublishSettings>(NpmPublishSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NpmPublishSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NpmPublishSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
SetRedirectedStandardErrorHandler(Action<string>) NpmSettings
Sets the StandardError-Action
Requires the Cake.Npm addin
SetRedirectedStandardOutputHandler(Action<string>) NpmSettings
Sets the StandardOutput-Action
Requires the Cake.Npm addin
ThrowIfNull<NpmPublishSettings>(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<NpmPublishSettings>(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
ToRegistry(Uri) NpmPublishSettings
Sets the registry where the package will be published to.
Requires the Cake.Npm addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin
WithAccess(NpmPublishAccess) NpmPublishSettings
Sets the access of the published package.
Requires the Cake.Npm addin
WithLogLevel(NpmLogLevel) NpmSettings
Sets the log level which should be used to run the npm command.
Requires the Cake.Npm addin
WithTag(string) NpmPublishSettings
Sets the tag of the package to publish.
Requires the Cake.Npm addin