Should-BeTrue
Contributions are welcome in Pester-repo.
SYNOPSIS​
Compares the actual value to a boolean $true. It does not convert input values to boolean, and will fail for any value is not $true.
SYNTAX​
Should-BeTrue [[-Actual] <Object>] [[-Because] <String>] [<CommonParameters>]
DESCRIPTION​
{{ Fill in the Description }}
EXAMPLES​
EXAMPLE 1​
$true | Should-BeTrue
This assertion will pass.
EXAMPLE 2​
$false | Should-BeTrue
Get-Process | Should-BeTrue
$null | Should-BeTrue
$() | Should-BeTrue
@() | Should-BeTrue
0 | Should-BeTrue
All of these assertions will fail, because the actual value is not $true.
PARAMETERS​
-Actual​
The actual value to compare to $true.
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-BeTrue
assertion is the opposite of the Should-BeFalse
assertion.
RELATED LINKS​
https://pester.dev/docs/commands/Should-BeTrue
https://pester.dev/docs/assertions
VERSION​
This page was generated using comment-based help in Pester 6.0.0-alpha5.