CakeEnvironment Class

Summary

Represents the environment Cake operates in.

Namespace

Interfaces

ICakeEnvironment

Base Types

object

graph BT Type-->Base0["object"] Type-.->Interface0["ICakeEnvironment"] click Interface0 "/api/Cake.Core/ICakeEnvironment" Type["CakeEnvironment"] class Type type-node

Syntax

public sealed class CakeEnvironment : ICakeEnvironment

Constructors

Name	Summary
CakeEnvironment(ICakePlatform, ICakeRuntime)	Initializes a new instance of the `CakeEnvironment` class.

Properties

Name	Value	Summary
ApplicationRoot	DirectoryPath	Gets the application root path.
Platform	ICakePlatform	Gets the platform Cake is running on.
Runtime	ICakeRuntime	Gets the runtime Cake is running in.
UserHomeDirectory	DirectoryPath	Gets the user's home directory.
WorkingDirectory	DirectoryPath	Gets or sets the working directory.

Methods

Name	Value	Summary
GetEnvironmentVariable(string)	string	Gets an environment variable.
GetEnvironmentVariables()	IDictionary<string, string>	Gets all environment variables.
GetSpecialPath(SpecialPath)	DirectoryPath	Gets a special path.

Extension Methods

Name	Value	Summary
Dump<CakeEnvironment>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
ExpandEnvironmentVariables(string)	string	Expands the environment variables in the provided text. From CakeEnvironmentExtensions
IsIn<CakeEnvironment>(CakeEnvironment[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CakeEnvironment>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<CakeEnvironment>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<CakeEnvironment>(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<CakeEnvironment>(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
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin