Skip to main content
Version: v6

Should-BeFalse

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS​

Compares the actual value to a boolean $false. It does not convert input values to boolean, and will fail for any value that is not $false.

SYNTAX​

Should-BeFalse [[-Actual] <Object>] [[-Because] <string>]

DESCRIPTION​

This assertion only passes for the Boolean value $false. It does not coerce input, so $null, 0, or other falsy values still fail.

EXAMPLES​

EXAMPLE 1​

$false | Should-BeFalse

This assertion will pass.

EXAMPLE 2​

$true | Should-BeFalse
Get-Process | Should-BeFalse
$null | Should-BeFalse
$() | Should-BeFalse
@() | Should-BeFalse
0 | Should-BeFalse

All of these assertions will fail, because the actual value is not $false.

PARAMETERS​

-Actual​

The actual value to compare to $false.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Because​

The reason why the input should be the expected value.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters​

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

INPUTS​

System.Object​

OUTPUTS​

NOTES​

The Should-BeFalse assertion is the opposite of the Should-BeTrue 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.

VERSION​

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