ICakeRuntime Interface

Summary

Represents the runtime that Cake is running in.
Namespace
Cake.Core
Implementing Types
graph BT Type["ICakeRuntime"] class Type type-node Implementing0["CakeRuntime"]-.->Type click Implementing0 "/api/Cake.Core/CakeRuntime" Implementing1["FakeRuntime"]-.->Type click Implementing1 "/api/Cake.Testing/FakeRuntime"

Syntax

public interface ICakeRuntime

Properties

Name Value Summary
BuiltFramework FrameworkName
Gets the build-time .NET framework version that is being used.
CakeVersion Version
Gets the version of Cake executing the script.
IsCoreClr bool
Gets a value indicating whether we're running on CoreClr.
Runtime Runtime
Gets the current executing .NET Runtime.

Extension Methods

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