Skip to main content
Version: v6

Should-BeSlowerThan

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS​

Asserts that the provided [timespan] is slower than the expected [timespan].

SYNTAX​

Should-BeSlowerThan [[-Actual] <Object>] [[-Expected] <Object>] [-Because <String>] [<CommonParameters>]

DESCRIPTION​

This assertion accepts either a [timespan] or a script block to measure. Fluent time values such as 1s are converted to a [timespan] before the comparison.

EXAMPLES​

EXAMPLE 1​

{ Start-Sleep -Seconds 10 } | Should-BeSlowerThan 2seconds

This assertion will pass, because the actual value is slower than the expected value.

EXAMPLE 2​

[Timespan]::fromSeconds(10) | Should-BeSlowerThan 2seconds

This assertion will pass, because the actual value is slower than the expected value.

EXAMPLE 3​

{ Start-Sleep -Seconds 1 } | Should-BeSlowerThan 10seconds

This assertion will fail, because the actual value is not slower than the expected value.

PARAMETERS​

-Actual​

The actual [timespan] or [scriptblock] value.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Expected​

The expected [timespan] or fluent time value.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Because​

The reason why the actual value should be slower than 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​

The Should-BeSlowerThan assertion is the opposite of the Should-BeFasterThan assertion.

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.

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

https://pester.dev/docs/assertions

VERSION​

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