Skip to main content
Version: v6 (preview) 🚧

Should-Any

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS​

Compares all items in a collection to a filter script. If the filter returns true, or does not throw for any of the items in the collection, the assertion passes.

SYNTAX​

Should-Any [[-Actual] <Object>] [-FilterScript] <ScriptBlock> [-Because <String>] [<CommonParameters>]

DESCRIPTION​

{{ Fill in the Description }}

EXAMPLES​

EXAMPLE 1​

1, 2, 3 | Should-Any { $_ -gt 2 }
1, 2, 3 | Should-Any { $_ | Should-BeGreaterThan 2 }

This assertion will pass, because at least one item in the collection passed the filter. 3 is greater than 2.

EXAMPLE 2​

1, 2, 3 | Should-Any { $_ -gt 4 }
1, 2, 3 | Should-Any { $_ | Should-BeGreaterThan 4 }

The assertions will fail because none of theitems in the array are greater than 4.

PARAMETERS​

-Actual​

A collection of items to filter.

Type: Object
Parameter Sets: (All)
Aliases:

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

-FilterScript​

A script block that filters the input collection. The script block can use Should-* assertions or throw exceptions to indicate failure.

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Because​

The reason why the input should be the expected value.

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-Any

https://pester.dev/docs/assertions

VERSION​

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