This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Karma.

Summary

The karma runner for local mode execution.

Assembly

Cake.Karma.dll

Namespace

Cake.Karma

Base Types

graph BT Type-->Base0["KarmaRunner<TSettings>"] Base0-->Base1["Tool<TSettings>"] Type["KarmaRunnerLocal<TSettings>"] class Type type-node

Syntax

public sealed class KarmaRunnerLocal<TSettings> : KarmaRunner<TSettings> 
    where TSettings : KarmaSettings, new()

Name	Description
TSettings	The type of settings to provide for the relevant karma command (start, run, init).

Name	Summary
KarmaRunnerLocal(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator)	Default constructor for `KarmaRunnerLocal<TSettings>`.

Name	Value	Summary
Execute(TSettings)	void	Execute the runner with the specified settings. If LocalKarmaCli is not set, it defaults to `DefaultLocalKarmaCli`.
GetToolExecutableNames()	IEnumerable<string>	Available tool executable names for local karma runs.
GetToolName()	string	The name of the tool, used during logging.
ValidateSettings(TSettings)	void	Validates the provides settings for local mode.

Name	Value	Summary
Dump<KarmaRunnerLocal<TSettings>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<KarmaRunnerLocal<TSettings>>(KarmaRunnerLocal<TSettings>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<KarmaRunnerLocal<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<KarmaRunnerLocal<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<KarmaRunnerLocal<TSettings>>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<KarmaRunnerLocal<TSettings>>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin