Should-NotBeString

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS

Asserts that the actual value is not equal to the expected value.

SYNTAX

Should-NotBeString [[-Actual] <Object>] [-Expected] <String> [-Because <String>] [-CaseSensitive]
 [-IgnoreWhitespace] [-TrimWhitespace] [-NormalizeLineEnding] [<CommonParameters>]

DESCRIPTION

The Should-NotBeString assertion compares the actual value to the expected value using the -ne operator. The -ne operator is case-insensitive by default, but you can make it case-sensitive by using the -CaseSensitive switch.

EXAMPLES

EXAMPLE 1

"hello" | Should-NotBeString "HELLO"

This assertion will pass, because the actual value is not equal to the expected value.

EXAMPLE 2

"hello" | Should-NotBeString "hello" -CaseSensitive

This assertion will fail, because the actual value is equal to the expected value.

PARAMETERS

-Actual

The actual value.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Expected

The expected value.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Because

The reason why the actual value should not be equal to the expected value.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CaseSensitive

Indicates that the comparison should be case-sensitive.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IgnoreWhitespace

Indicates that the comparison should ignore whitespace.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-TrimWhitespace

Trims whitespace at the start and end of the string.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-NormalizeLineEnding

Normalizes line endings before comparison, so that \r\n, \r, and the Unicode line separator are all treated as \n. Use this to compare multi-line strings across platforms without failing on line-ending style. Unlike -IgnoreWhitespace, the newlines and their positions are kept, so indentation and blank lines are still compared.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

The Should-NotBeString assertion is the opposite of the Should-BeString assertion.

Use the -ErrorAction parameter to control soft-assertion behavior for this assertion. -ErrorAction Continue records the failure and lets the rest of the test run (a soft assertion), while -ErrorAction Stop fails the test immediately, for example to guard a precondition before continuing.

When -ErrorAction is not specified, the behavior comes from Should.ErrorAction in the configuration, which defaults to Stop. See https://pester.dev/docs/assertions/soft-assertions for more about soft assertions.

RELATED LINKS

https://pester.dev/docs/commands/Should-NotBeString

https://pester.dev/docs/assertions

VERSION

This page was generated using comment-based help in Pester 6.1.0.