CakeTaskBuilderExtensions.

OnError<TData>(CakeTaskBuilder, Func<Exception, ICakeContext, TData, Task>) Method

Summary

Adds an error handler to be executed if an exception occurs in the task.
Namespace
Cake.Core
Containing Type
CakeTaskBuilderExtensions

Syntax

public static CakeTaskBuilder OnError<TData>(this CakeTaskBuilder builder, Func<Exception, ICakeContext, TData, Task> errorHandler) 
    where TData : class

Examples

Task("Risky")
    .OnError<Foo>(async (ex, context, data) =>
    {
        context.Log.Error("{0}: {1}", data.Place, ex.Message);
        await System.Threading.Tasks.Task.CompletedTask;
    })
    .Does(() => { });

Type Parameters

Name Description
TData The extra data to operate with inside the error handler.

Parameters

Name Type Description
builder CakeTaskBuilder The builder.
errorHandler Func<Exception, ICakeContext, TData, Task> The error handler.

Return Value

Type Description
CakeTaskBuilder The same CakeTaskBuilder instance so that multiple calls can be chained.