NpmAddUserSettings Class

Summary

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

Syntax

public class NpmAddUserSettings : NpmSettings

Constructors

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

Properties

Name Value Summary
AlwaysAuth bool
Gets a value indicating that all requests to the given registry should include authorization information. Defaults to false.
AuthType AuthType
Gets or sets the authentication stragety to use. Defaults to AuthType.Legacy
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
Inherited from NpmSettings
RedirectStandardOutput bool
Gets or sets the process option to redirect standard output
Inherited from NpmSettings
Registry Uri
Gets or sets a value indicating which registry we should point to. Defaulted to the current NPM configuration.
Scope string
Gets or sets a value indicating the specificed scope for the user and login credentials provided. Defaults to string.Empty.

Methods

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

Extension Methods

Name Value Summary
AlwaysAuthenticate() NpmAddUserSettings
Force npm to always require authentication when accessing the registry, even for GET requests.
Requires the Cake.Npm addin
Dump<NpmAddUserSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
ForRegistry(Uri) NpmAddUserSettings
Instructs npm to add user for the given registry.
Requires the Cake.Npm addin
ForScope(string) NpmAddUserSettings
Sets scope for credentials.
Requires the Cake.Npm addin
FromPath(DirectoryPath) NpmSettings
Sets the working directory which should be used to run the npm command.
Requires the Cake.Npm addin
IsIn<NpmAddUserSettings>(NpmAddUserSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NpmAddUserSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NpmAddUserSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<NpmAddUserSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<NpmAddUserSettings>(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
UsingAuthentication(AuthType) NpmAddUserSettings
Defines the authentication strategy to use.
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