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

Summary

Yarn install options

Assembly

Cake.Yarn.dll

Namespace

Cake.Yarn

Base Types

ToolSettings
YarnRunnerSettings

graph BT Type-->Base0["YarnRunnerSettings"] click Base0 "/api/Cake.Yarn/YarnRunnerSettings" Base0-->Base1["ToolSettings"] Type["YarnInstallSettings"] class Type type-node

Syntax

public class YarnInstallSettings : YarnRunnerSettings

Constructors

Name	Summary
YarnInstallSettings()	Yarn "install" settings

Properties

Name	Value	Summary
Arguments	IReadOnlyCollection<string>	Arguments to pass to the target script
Command	string	The command being ran Inherited from YarnRunnerSettings
FrozenLockfile	bool	--frozen-lockfile
IgnoreEngines	bool	--ignore-engines
IgnoreOptional	bool	--ignore-optional
IgnorePlatform	bool	--ignore-platform
OfflineInstall	bool	--offline
Production	bool	--production

Methods

Name	Value	Summary
EvaluateCore(ProcessArgumentBuilder)	void	Evaluate options
ForProduction(bool)	YarnInstallSettings	Applies the --production parameter (can not be set when installing individual packages
IgnoreEnginesWarnings(bool)	YarnInstallSettings	Applies the --ignore-engines parameter
IgnoreOptionalWarnings(bool)	YarnInstallSettings	Applies the --ignore-optional parameter
IgnorePlatformWarnings(bool)	YarnInstallSettings	Applies the --ignore-platform parameter
Offline(bool)	YarnInstallSettings	Applies the --offline parameter
WithArgument(string)	YarnInstallSettings	Apply any individual argument.
WithFrozenLockfile(bool)	YarnInstallSettings	Applies the --frozen-lockfile parameter

Extension Methods