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
Settings shared across start and run commands.
- Assembly
- Cake
.Karma .dll - Namespace
- Cake
.Karma - Base Types
-
- ToolSettings
- KarmaSettings
- Derived Types
graph BT
Type-->Base0["KarmaSettings"]
click Base0 "/api/Cake.Karma/KarmaSettings"
Base0-->Base1["ToolSettings"]
Type["KarmaSharedSettings"]
class Type type-node
Derived0["KarmaStartSettings"]-->Type
click Derived0 "/api/Cake.Karma/KarmaStartSettings"
Derived1["KarmaRunSettings"]-->Type
click Derived1 "/api/Cake.Karma/KarmaRunSettings"
Syntax
public abstract class KarmaSharedSettings : KarmaSettingsConstructors
| Name | Summary |
|---|---|
| KarmaSharedSettings |
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 |
|---|---|---|
| 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
|
| FailOnEmptyTestSuite | bool |
Fail on empty test suite.
Defaults to false.
|
| 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 |
Level of logging.
Inherited from KarmaSettings
|
| NoColors | bool |
Do not use colors when reporting or printing logs.
Defaults to false.
Inherited from KarmaSettings
|
| No |
bool |
Do not fail on empty test suite.
Defaults to false.
|
| Port | Nullable |
Port where the server is listening.
|
| RunMode | KarmaRunMode |
Run karma locally or globally. Defaults to KarmaRunMode.Global.
Inherited from KarmaSettings
|
Methods
| Name | Value | Summary |
|---|---|---|
| EvaluateCore |
void |
Applies the settings to the process arguments ready for execution.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
From StringExtensions
Requires the Cake.Issues addin
|