Skip to main content
Version: v4

Get-ShouldOperator

This page was generated

Contributions are welcome in Pester v4-repo.

SYNOPSIS​

Display the assertion operators available for use with Should.

SYNTAX​

Get-ShouldOperator [-Name <string>]

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: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  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​

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 *).

VERSION​

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