CakeTaskBuilderOfTExtensions Class

Summary

Contains extension methods for CakeTaskBuilder<TData>.
Namespace
Cake.Core
Base Types
  • object
graph BT Type-->Base0["object"] Type["CakeTaskBuilderOfTExtensions"] class Type type-node

Syntax

public static class CakeTaskBuilderOfTExtensions

Methods

Name Value Summary
ContinueOnError<TData>(CakeTaskBuilder<TData>) CakeTaskBuilder<TData>
Adds an indication to the task that a thrown exception will not halt the script execution.
static
DeferOnError<TData>(CakeTaskBuilder<TData>) CakeTaskBuilder<TData>
Defers all exceptions until after all actions for this task have completed.
static
Description<TData>(CakeTaskBuilder<TData>, string) CakeTaskBuilder<TData>
Adds a description to the task.
static
Does<TData>(CakeTaskBuilder<TData>, Action<ICakeContext, TData>) CakeTaskBuilder<TData>
Adds an action to be executed when the task is invoked.
static
Does<TData>(CakeTaskBuilder<TData>, Func<ICakeContext, TData, Task>) CakeTaskBuilder<TData>
Adds an action to be executed when the task is invoked.
static
DoesForEach<TData, TItem>(CakeTaskBuilder<TData>, Func<TData, ICakeContext, IEnumerable<TItem>>, Action<TData, TItem, ICakeContext>) CakeTaskBuilder<TData>
Adds an action to be executed foreach item returned by the items function. This method will be executed the first time the task is executed.
static
DoesForEach<TData, TItem>(CakeTaskBuilder<TData>, IEnumerable<TItem>, Action<TData, TItem, ICakeContext>) CakeTaskBuilder<TData>
Adds an action to be executed foreach item returned by the items function. This method will be executed the first time the task is executed.
static
Finally<TData>(CakeTaskBuilder<TData>, Action<ICakeContext, TData>) CakeTaskBuilder<TData>
Adds a finally handler to be executed after the task have finished executing.
static
Finally<TData>(CakeTaskBuilder<TData>, Func<ICakeContext, TData, Task>) CakeTaskBuilder<TData>
Adds a finally handler to be executed after the task have finished executing.
static
IsDependeeOf<TData>(CakeTaskBuilder<TData>, CakeTaskBuilder<TData>) CakeTaskBuilder<TData>
Makes the task a dependee of another task.
static
IsDependeeOf<TData>(CakeTaskBuilder<TData>, string) CakeTaskBuilder<TData>
Makes the task a dependee of another task.
static
IsDependentOn<TData>(CakeTaskBuilder<TData>, CakeTaskBuilder) CakeTaskBuilder<TData>
Creates a dependency between two tasks.
static
IsDependentOn<TData>(CakeTaskBuilder<TData>, CakeTaskBuilder<TData>) CakeTaskBuilder<TData>
Creates a dependency between two tasks.
static
IsDependentOn<TData>(CakeTaskBuilder<TData>, string) CakeTaskBuilder<TData>
Creates a dependency between two tasks.
static
Of<TData>(CakeTaskBuilder) CakeTaskBuilder<TData>
Gives a CakeTaskBuilder<TData> bound to specific data context type.
static
OnError<TData>(CakeTaskBuilder<TData>, Action<Exception, ICakeContext, TData>) CakeTaskBuilder<TData>
Adds an error handler to be executed if an exception occurs in the task.
static
OnError<TData>(CakeTaskBuilder<TData>, Func<Exception, ICakeContext, TData, Task>) CakeTaskBuilder<TData>
Adds an error handler to be executed if an exception occurs in the task.
static
ReportError<TData>(CakeTaskBuilder<TData>, Action<Exception>) CakeTaskBuilder<TData>
Adds an error reporter for the task to be executed when an exception is thrown from the task. This action is invoked before the error handler, but gives no opportunity to recover from the error.
static
WithCriteria<TData>(CakeTaskBuilder<TData>, Func<ICakeContext, TData, bool>, string) CakeTaskBuilder<TData>
Adds a criteria that has to be fulfilled for the task to run. The criteria is evaluated when traversal of the graph occurs.
static
WithCriteria<TData>(CakeTaskBuilder<TData>, Func<ICakeContext, TData, bool>) CakeTaskBuilder<TData>
Adds a criteria that has to be fulfilled for the task to run. The criteria is evaluated when traversal of the graph occurs.
static

Extension Methods

Name Value Summary
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