Summary

The script host used to execute Cake scripts.

Namespace

Interfaces

IScriptHost

Base Types

graph BT Type-->Base0["BuildScriptHost<ICakeContext>"] Base0-->Base1["ScriptHost"] click Base1 "/api/Cake.Core.Scripting/ScriptHost" Base1-->Base2["object"] Type-.->Interface0["IScriptHost"] click Interface0 "/api/Cake.Core.Scripting/IScriptHost" Type["BuildScriptHost"] class Type type-node

Syntax

public sealed class BuildScriptHost : BuildScriptHost<ICakeContext>, IScriptHost

Constructors

Name	Summary
BuildScriptHost(ICakeEngine, IExecutionStrategy, ICakeContext, ICakeReportPrinter, ICakeLog)	Initializes a new instance of the `BuildScriptHost` class.

Properties

Name	Value	Summary
Context	ICakeContext	Gets the context. Inherited from ScriptHost
Engine	ICakeEngine	Gets the engine. Inherited from ScriptHost
Settings	ExecutionSettings	Gets the settings. Inherited from ScriptHost
Tasks	IReadOnlyList<ICakeTaskInfo>	Gets all registered tasks. Inherited from ScriptHost

Methods

Name	Value	Summary
RunTarget(string)	CakeReport	Runs the specified target. Inherited from ScriptHost
RunTargets(IEnumerable<string>)	CakeReport	Runs the specified targets. Inherited from ScriptHost
Setup(Action<ISetupContext>)	void	Allows registration of an action that's executed before any tasks are run. If setup fails, no tasks will be executed but teardown will be performed. Inherited from ScriptHost
Setup<TData>(Func<ISetupContext, TData>)	void	Allows registration of an action that's executed before any tasks are run. If setup fails, no tasks will be executed but teardown will be performed. Inherited from ScriptHost
Task(string)	CakeTaskBuilder	Registers a new task. Inherited from ScriptHost
TaskOf<TData>(string)	CakeTaskBuilder<TData>	Registers a new task. Inherited from ScriptHost
TaskSetup(Action<ITaskSetupContext>)	void	Allows registration of an action that's executed before each task is run. If the task setup fails, its task will not be executed but the task teardown will be performed. Inherited from ScriptHost
TaskSetup<TData>(Action<ITaskSetupContext, TData>)	void	Allows registration of an action that's executed before each task is run. If the task setup fails, its task will not be executed but the task teardown will be performed. Inherited from ScriptHost
TaskTeardown(Action<ITaskTeardownContext>)	void	Allows registration of an action that's executed after each task has been run. If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed. Inherited from ScriptHost
TaskTeardown<TData>(Action<ITaskTeardownContext, TData>)	void	Allows registration of an action that's executed after each task has been run. If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed. Inherited from ScriptHost
Teardown(Action<ITeardownContext>)	void	Allows registration of an action that's executed after all other tasks have been run. If a setup action or a task fails with or without recovery, the specified teardown action will still be executed. Inherited from ScriptHost
Teardown<TData>(Action<ITeardownContext, TData>)	void	Allows registration of an action that's executed after all other tasks have been run. If a setup action or a task fails with or without recovery, the specified teardown action will still be executed. Inherited from ScriptHost

Extension Methods