Header menu logo testify

TestifyConfig Module

Functions and values

Function or value Description

TestifyConfig.addCheckConfigTransformer transformer config

Full Usage: TestifyConfig.addCheckConfigTransformer transformer config

Parameters:
    transformer : Config -> Config - The transformer that should adjust the default FsCheck configuration.
    config : TestifyConfig - The existing Testify configuration.

Returns: TestifyConfig A copy of config with the transformer appended.

Adds one transformer that augments the default FsCheck configuration used by Testify property checks.

transformer : Config -> Config

The transformer that should adjust the default FsCheck configuration.

config : TestifyConfig

The existing Testify configuration.

Returns: TestifyConfig

A copy of config with the transformer appended.

Example

 let config =
     TestifyConfig.defaults
     |> TestifyConfig.addCheckConfigTransformer CheckConfig.addMiniArbs
val config: obj

TestifyConfig.defaults

Full Usage: TestifyConfig.defaults

Returns: TestifyConfig A configuration with default report options, no hint rules, no hint packs, and no property-config transformers.

The neutral Testify configuration.

Returns: TestifyConfig

A configuration with default report options, no hint rules, no hint packs, and no property-config transformers.

Example

 let config = TestifyConfig.defaults
val config: obj

TestifyConfig.withHintPacks packs config

Full Usage: TestifyConfig.withHintPacks packs config

Parameters:
    packs : TestifyHintPack list - The hint packs that should replace the current list.
    config : TestifyConfig - The existing Testify configuration.

Returns: TestifyConfig A copy of config with its hint packs replaced.

Replaces the configured hint packs used by Testify.

packs : TestifyHintPack list

The hint packs that should replace the current list.

config : TestifyConfig

The existing Testify configuration.

Returns: TestifyConfig

A copy of config with its hint packs replaced.

Example

 let config =
     TestifyConfig.defaults
     |> TestifyConfig.withHintPacks BuiltInHintPacks.beginner
val config: obj

TestifyConfig.withHints rules config

Full Usage: TestifyConfig.withHints rules config

Parameters:
    rules : TestifyHintRule list - The explicit hint rules that should replace the current list.
    config : TestifyConfig - The existing Testify configuration.

Returns: TestifyConfig A copy of config with its hint rules replaced.

Replaces the configured hint rules used by Testify.

rules : TestifyHintRule list

The explicit hint rules that should replace the current list.

config : TestifyConfig

The existing Testify configuration.

Returns: TestifyConfig

A copy of config with its hint rules replaced.

Example

 let whitespaceHint =
     TestifyHintRule.onFieldRegexPattern
         "Whitespace.Trailing"
         HintTextField.ActualValue
         @"\s+$"
         (fun _ -> "The value appears to end with trailing whitespace.")

 let config =
     TestifyConfig.defaults
     |> TestifyConfig.withHints [ whitespaceHint ]
val whitespaceHint: obj
val config: obj

TestifyConfig.withOutputFormat outputFormat config

Full Usage: TestifyConfig.withOutputFormat outputFormat config

Parameters:
    outputFormat : OutputFormat - The new rendered output format, such as WallOfText or Json.
    config : TestifyConfig - The existing Testify configuration.

Returns: TestifyConfig A copy of config with its report output format replaced.

Replaces the configured output format used by Testify rendering.

outputFormat : OutputFormat

The new rendered output format, such as WallOfText or Json.

config : TestifyConfig

The existing Testify configuration.

Returns: TestifyConfig

A copy of config with its report output format replaced.

Example

 let config =
     TestifyConfig.defaults
     |> TestifyConfig.withOutputFormat OutputFormat.Json
val config: obj

TestifyConfig.withReportOptions options config

Full Usage: TestifyConfig.withReportOptions options config

Parameters:
Returns: TestifyConfig A copy of config that uses options.

Replaces the default report options used by Testify.

options : TestifyReportOptions

The new report options to install into the configuration.

config : TestifyConfig

The existing Testify configuration.

Returns: TestifyConfig

A copy of config that uses options.

Type something to start searching.