Skip to main content
Version: v6 (preview) 🚧

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>] [<CommonParameters>]

DESCRIPTION​

{{ Fill in the Description }}

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: Object
Parameter Sets: (All)
Aliases:

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

-Because​

The reason why the input should be the expected value.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
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-BeFalse assertion is the opposite of the Should-BeTrue assertion.

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

https://pester.dev/docs/assertions

VERSION​

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