Should-BeNull

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS

Asserts that the input is $null.

SYNTAX

Should-BeNull [[-Actual] <Object>] [-Because <String>] [<CommonParameters>]

DESCRIPTION

This assertion passes only when the actual value is exactly `$null. Empty strings, empty collections, and other falsy values do not count as null.

EXAMPLES

EXAMPLE 1

$null | Should-BeNull

This assertion will pass, because the actual value is $null.

PARAMETERS

-Actual

The actual value.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Because

The reason why the input should be $null.

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

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.

RELATED LINKS

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

https://pester.dev/docs/assertions

VERSION

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