Script Class

Summary

Represents a script.
Namespace
Cake.Core.Scripting
Base Types
  • object
graph BT Type-->Base0["object"] Type["Script"] class Type type-node

Syntax

public sealed class Script

Constructors

Properties

Name Value Summary
Aliases IReadOnlyList<ScriptAlias>
Gets the aliases.
Defines IReadOnlyList<string>
Gets the defines.
ExcludedNamespaces IDictionary<string, IList<string>>
Gets the namespaces flagged to be excluded by code generation and affected aliases.
Lines IReadOnlyList<string>
Gets the script lines.
Namespaces IReadOnlyList<string>
Gets the namespaces imported via the using statement.
UsingAliasDirectives IReadOnlyList<string>
Gets the using alias directives.
UsingStaticDirectives IReadOnlyList<string>
Gets the using static directives.

Extension Methods

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