Version: v4

Get-ShouldOperator

SYNOPSIS#

Display the assertion operators available for use with Should.

SYNTAX#

Get-ShouldOperator [-Name <String>] [<CommonParameters>]

DESCRIPTION#

Get-ShouldOperator returns a list of available Should parameters, their aliases, and examples to help you craft the tests you need.

Get-ShouldOperator will list all available operators, including any registered by the user with Add-AssertionOperator.

EXAMPLES#

EXAMPLE 1#

Get-ShouldOperator

Return all available Should assertion operators and their aliases.

EXAMPLE 2#

Get-ShouldOperator -Name Be

Return help examples for the Be assertion operator. -Name is a dynamic parameter that tab completes all available options.

PARAMETERS#

-Name#

{{ Fill Name Description }}

Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
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#

Pester uses dynamic parameters to populate Should arguments.

This limits the user's ability to discover the available assertions via standard PowerShell discovery patterns (like Get-Help Should -Parameter *).

RELATED LINKS#

https://pester.dev/docs/v4/commands/Should

EDIT THIS PAGE#

This page was auto-generated using Pester's comment based help. To edit the content of this page, change the corresponding help in the pester/Pester repository. See our contribution guide for more information.