Should-NotBeNull

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS

Asserts that the input is not $null.

SYNTAX

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

DESCRIPTION

This assertion passes for any value other than exactly `$null. Empty strings, empty collections, and other falsy values are not treated as null.

EXAMPLES

EXAMPLE 1

"hello" | Should-NotBeNull
1 | Should-NotBeNull

These assertions will pass, because the actual value is not `$null.

PARAMETERS

-Actual

The actual value.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Because

The reason why the input should not be $null.

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.

RELATED LINKS

• https://pester.dev/docs/commands/Should-NotBeNull
• https://pester.dev/docs/assertions

VERSION

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