CLIReporterSettings Class

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.Newman.

Summary

Settings for the CLI Reporter

Assembly

Cake.Newman.dll

Namespace

Cake.Newman.Reporters

Interfaces

IReporterSettings

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["IReporterSettings"] click Interface0 "/api/Cake.Newman.Reporters/IReporterSettings" Type["CLIReporterSettings"] class Type type-node

Syntax

public class CLIReporterSettings : IReporterSettings

Constructors

Name	Summary
CLIReporterSettings()

Properties

Name	Value	Summary
NoAssertions	bool	This turns off the request-wise output as they happen.
NoConsole	bool	This turns off the output of console.log (and other console calls) from collection's scripts.
NoSummary	bool	The statistical summary table is not shown.
SeparateFailures	bool	This prevents the run failures from being separately printed.
Silent	bool	The CLI reporter is internally disabled and you see no output to terminal.

Methods

Name	Value	Summary
RenderOptions(ProcessArgumentBuilder)	void	Outputs the reporter-specific settings to include in the invocation

Extension Methods

Name	Value	Summary
DisableAssertions()	CLIReporterSettings	Turns off the request-wise output as they happen. From CLIReporterSettingsExtensions Requires the Cake.Newman addin
DisableConsoleOutput()	CLIReporterSettings	Turns off the output of `console.log` (and other console calls) from collection's scripts. From CLIReporterSettingsExtensions Requires the Cake.Newman addin
DisableSeparateFailures()	CLIReporterSettings	Prevents the run failures from being separately printed. From CLIReporterSettingsExtensions Requires the Cake.Newman addin
DisableSummary()	CLIReporterSettings	Disables the statistical summary table from being shown. From CLIReporterSettingsExtensions Requires the Cake.Newman addin
Dump<CLIReporterSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<CLIReporterSettings>(CLIReporterSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CLIReporterSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<CLIReporterSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
RunSilently()	CLIReporterSettings	Disables the CLI reporter internally and no output is sent to the console From CLIReporterSettingsExtensions Requires the Cake.Newman addin
ThrowIfNull<CLIReporterSettings>(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<CLIReporterSettings>(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