Skip to main content
Version: v6

Should-BeEmptyString

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS​

Ensures that input is an empty string.

SYNTAX​

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

DESCRIPTION​

This assertion requires the actual value to be a string and uses [string]::IsNullOrEmpty() for the check. $null and non-string values still fail the assertion.

EXAMPLES​

EXAMPLE 1​

$actual = ""
$actual | Should-BeEmptyString

This test will pass.

EXAMPLE 2​

$actual = "hello"
$actual | Should-BeEmptyString

This test will fail, the input is not an empty string.

EXAMPLE 3​

$null | Should-BeEmptyString
@() | Should-BeEmptyString
$() | Should-BeEmptyString
$false | Should-BeEmptyString

All the tests above will fail, the input is not a string.

PARAMETERS​

-Actual​

The actual value that will be compared to an empty string.

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 an empty string.

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​

System.Object​

OUTPUTS​

NOTES​

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.