Summary

Contains functionality related to arguments.

Namespace

Base Types

graph BT Type-->Base0["object"] Type["ArgumentAliases"] class Type type-node

Syntax

[CakeAliasCategory("Arguments")]
public static class ArgumentAliases

Type	Description
CakeAliasCategoryAttribute	An attribute used for documentation of alias methods/properties.

Name	Value	Summary
Argument<T>(ICakeContext, string, T)	T	Gets an argument and returns the provided defaultValue if the argument is missing. static
Argument<T>(ICakeContext, string)	T	Gets an argument and throws if the argument is missing. static
Arguments(ICakeContext)	IDictionary<string, ICollection<string>>	Retrieves all command line arguments. static
Arguments<T>(ICakeContext, string, Func<ICakeContext, ICollection<T>>)	ICollection<T>	Gets all arguments with the specific name, evaluates and returns the provided defaultValues if the argument is missing. static
Arguments<T>(ICakeContext, string, ICollection<T>)	ICollection<T>	Gets all arguments with the specific name and returns the provided defaultValues if the argument is missing. static
Arguments<T>(ICakeContext, string, T)	ICollection<T>	Gets all arguments with the specific name and returns the provided defaultValue if the argument is missing. static
Arguments<T>(ICakeContext, string)	ICollection<T>	Gets all arguments with the specific name and throws if the argument is missing. static
HasArgument(ICakeContext, string)	bool	Determines whether or not the specified argument exist. static

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