Skip to main content
Version: v6 (preview) 🚧

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

DESCRIPTION​

{{ Fill in the Description }}

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

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​

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

https://pester.dev/docs/assertions

VERSION​

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