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 [[-Expected] <Object>] [[-Actual] <Object>] [-Because <string>]

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: 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 actual value should be slower than the expected value.

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

-Expected

The expected [timespan] or fluent time value.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  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

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.

RELATED LINKS

• 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.