NpmInstallSettingsExtensions Class

Summary

Extensions for NpmInstallSettings.
Assembly
Cake.Npm.dll
Namespace
Cake.Npm.Install
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["NpmInstallSettingsExtensions"] class Type type-node

Syntax

public static class NpmInstallSettingsExtensions

Methods

Name Value Summary
AddPackage(NpmInstallSettings, string, string, string) NpmInstallSettings
Install a package by name, version/tag and scope.
static
AddPackage(NpmInstallSettings, string, string) NpmInstallSettings
Install a package by name and version/tag.
static
AddPackage(NpmInstallSettings, string) NpmInstallSettings
Install a package by name, version/tag.
static
AddPackage(NpmInstallSettings, Uri) NpmInstallSettings
Install a package from a specific url.
static
AddScopedPackage(NpmInstallSettings, string, string) NpmInstallSettings
Install a scoped package by name, version/tag.
static
ForProduction(NpmInstallSettings) NpmInstallSettings
Defines that npm should ignore modules listed in devDependencies.
static
FromRegistry(NpmInstallSettings, Uri) NpmInstallSettings
Instructs npm to look for packages in the given registry.
static
InstallGlobally(NpmInstallSettings) NpmInstallSettings
Defines that the package should be installed globally.
static
InstallLocally(NpmInstallSettings) NpmInstallSettings
Defines that the package should be installed locally.
static
WithForce(NpmInstallSettings, bool) NpmInstallSettings
Defines whether npm should fetch remote resources even if a local copy exists on disk.
static
WithForce(NpmInstallSettings) NpmInstallSettings
Defines that npm should fetch remote resources even if a local copy exists on disk.
static
WithNoOptional(NpmInstallSettings, bool) NpmInstallSettings
Defines whether npm should prevent optional dependencies from being installed
static
WithOptionalDependencies(NpmInstallSettings) NpmInstallSettings
Defines that npm should install optional dependencies
static
WithoutForce(NpmInstallSettings) NpmInstallSettings
Defines that npm should not fetch remote resources if a local copy exists on disk.
static
WithoutOptionalDependencies(NpmInstallSettings) NpmInstallSettings
Defines that npm should prevent optional dependencies from being installed
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin