YarnRunSettings Class

Summary

yarn run options
Assembly
Cake.Yarn.dll
Namespace
Cake.Yarn
Base Types
graph BT Type-->Base0["YarnRunnerSettings"] click Base0 "/api/Cake.Yarn/YarnRunnerSettings" Base0-->Base1["ToolSettings"] Type["YarnRunSettings"] class Type type-node

Syntax

public class YarnRunSettings : YarnRunnerSettings

Constructors

Name Summary
YarnRunSettings() yarn 'run' settings
YarnRunSettings(string) yarn 'run' settings for the named script

Properties

Name Value Summary
Arguments IList<string>
Arguments to pass to the target script
Command string
The command being ran
Inherited from YarnRunnerSettings
ScriptName string
Name of the script to execute as defined in package.json
Silent bool
Skip Yarn console logs, other types of logs (script output) will be printed

Methods

Name Value Summary
EvaluateCore(ProcessArgumentBuilder) void
Evaluate options
WithArgument(string) YarnRunSettings
Add an argument
WithSilent() YarnRunSettings
Sets Silent property to true

Extension Methods

Name Value Summary
Dump<YarnRunSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<YarnRunSettings>(YarnRunSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<YarnRunSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<YarnRunSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<YarnRunSettings>(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<YarnRunSettings>(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