LibManInstallSettings Class

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.LibMan.

Summary

Contains settings used by LibManInstaller.

Assembly

Cake.LibMan.dll

Namespace

Cake.LibMan.Install

Base Types

ToolSettings
LibManSettings

graph BT Type-->Base0["LibManSettings"] click Base0 "/api/Cake.LibMan/LibManSettings" Base0-->Base1["ToolSettings"] Type["LibManInstallSettings"] class Type type-node

Syntax

public class LibManInstallSettings : LibManSettings

Constructors

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

Properties

Name	Value	Summary
Command	string	Gets the command which should be run. Inherited from LibManSettings
Destination	DirectoryPath	The location to install the library. If not specified, the default location is used. If no defaultDestination property is specified in libman.json, this option is required.
Files	IList<FilePath>	Specify the name of the file to install from the library. If not specified, all files from the library are installed. Provide one --files option per file to be installed. Relative paths are supported too. For example: --files dist/browser/signalr.js.
Library	string	The name of the library to install. This name may include version number notation (for example, @1.2.0). This is required.
Provider	CdnProvider	The name of the provider to use for the library acquisition. If not specified, the defaultProvider property in libman.json is used. If no defaultProvider property is specified in libman.json, this option is required.
RedirectStandardError	bool	Gets or sets the process option to redirect standard error Inherited from LibManSettings
RedirectStandardOutput	bool	Gets or sets the process option to redirect standard output Inherited from LibManSettings
Verbosity	LibManVerbosity	Gets or sets the verbosity level which should be used to run the libman command. Inherited from LibManSettings

Methods

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

Extension Methods

Name	Value	Summary
AddFile(FilePath)	LibManInstallSettings	Adds a specific file to restore from the library. From LibManInstallExtensions Requires the Cake.LibMan addin
Dump<LibManInstallSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
FromPath(DirectoryPath)	LibManSettings	Sets the working directory which should be used to run the libman command. From LibManSettingsExtensions Requires the Cake.LibMan addin
IsIn<LibManInstallSettings>(LibManInstallSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<LibManInstallSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<LibManInstallSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
SetLibrary(string, string, string)	LibManInstallSettings	Installs a client side library by name, version, and scope. From LibManInstallExtensions Requires the Cake.LibMan addin
SetLibrary(string, string)	LibManInstallSettings	Installs a client side library by name and scope. From LibManInstallExtensions Requires the Cake.LibMan addin
SetLibrary(string)	LibManInstallSettings	Installs a client side library by name and version. From LibManInstallExtensions Requires the Cake.LibMan addin
SetLibraryFromPath(string)	LibManInstallSettings	Installs a client side library by file Path or Url. Sets the CdnProvider to filesystem. From LibManInstallExtensions Requires the Cake.LibMan addin
SetScopedLibrary(string, string)	LibManInstallSettings	Installs a client side library by name and scope. From LibManInstallExtensions Requires the Cake.LibMan addin
ThrowIfNull<LibManInstallSettings>(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<LibManInstallSettings>(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
WithDestination(DirectoryPath)	LibManInstallSettings	Sets the destination directory path to install the client side library files too. From LibManInstallExtensions Requires the Cake.LibMan addin
WithProvider(CdnProvider)	LibManInstallSettings	Sets the cbn provider to retrieve the client side library from. Cannot set to Default. From LibManInstallExtensions Requires the Cake.LibMan addin
WithVerbosity(LibManVerbosity)	LibManSettings	Sets the verbosity level which should be used to run the libman command. From LibManSettingsExtensions Requires the Cake.LibMan addin