Summary
Represents the environment Cake operates in.
- Namespace
- Cake
.Core - Implementing Types
graph BT
Type["ICakeEnvironment"]
class Type type-node
Implementing0["CakeEnvironment"]-.->Type
click Implementing0 "/api/Cake.Core/CakeEnvironment"
Implementing1["FakeEnvironment"]-.->Type
click Implementing1 "/api/Cake.Testing/FakeEnvironment"
Syntax
public interface ICakeEnvironmentProperties
| 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 |
|---|---|---|
| Get |
string |
Gets an environment variable.
|
| Get |
IDictionary |
Gets all environment variables.
|
| GetSpecialPath |
DirectoryPath |
Gets a special path.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| Expand |
string |
Expands the environment variables in the provided text.
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|