KarmaStartSettings Class

Summary

Settings specific to karma start.
Assembly
Cake.Karma.dll
Namespace
Cake.Karma
Base Types
graph BT Type-->Base0["KarmaSharedSettings"] click Base0 "/api/Cake.Karma/KarmaSharedSettings" Base0-->Base1["KarmaSettings"] click Base1 "/api/Cake.Karma/KarmaSettings" Base1-->Base2["ToolSettings"] Type["KarmaStartSettings"] class Type type-node

Syntax

public class KarmaStartSettings : KarmaSharedSettings

Constructors

Name Summary
KarmaStartSettings()

Fields

Name Constant Value Summary
DefaultLocalKarmaCli node_modules/karma-cli/bin/karma
The default Karma CLI file, if one is not specified during local run mode.
Inherited from KarmaSettings
static

Properties

Name Value Summary
AutoWatch bool
Auto watch source files and run on change.
Browsers ICollection<string>
List of browsers to start.
CaptureTimeout Nullable<int>
Kill browser if does not capture in given time (ms).
Colors bool
Use colors when reporting or printing logs. Defaults to false.
Inherited from KarmaSettings
ConfigFile FilePath
The conf.js file to use.
Inherited from KarmaSettings
Detached bool
Detach the server.
FailOnEmptyTestSuite bool
Fail on empty test suite. Defaults to false.
Inherited from KarmaSharedSettings
LocalKarmaCli FilePath
Path to Karma CLI. Use this if you want to utilise a local Karma deployment, otherwise Global use is attempted.
Inherited from KarmaSettings
LogLevel Nullable<KarmaLogLevel>
Level of logging.
Inherited from KarmaSettings
NoAutoWatch bool
Do not watch source files.
NoColors bool
Do not use colors when reporting or printing logs. Defaults to false.
Inherited from KarmaSettings
NoFailOnEmptyTestSuite bool
Do not fail on empty test suite. Defaults to false.
Inherited from KarmaSharedSettings
NoSingleRun bool
Disable single-run.
Port Nullable<int>
Port where the server is listening.
Inherited from KarmaSharedSettings
Reporters ICollection<KarmaReporter>
List of reporters.
ReportSlowerThan Nullable<int>
Report tests that are slower then given time (ms).
RunMode KarmaRunMode
Run karma locally or globally. Defaults to KarmaRunMode.Global.
Inherited from KarmaSettings
SingleRun bool
Run the test when the browsers captured and exit.

Methods

Name Value Summary
EvaluateCore(ProcessArgumentBuilder) void
Applies the settings to the process arguments ready for execution.

Extension Methods

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