Skip to main content
Version: v6 (preview) 🚧

Should-BeFasterThan

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS​

Asserts that the provided [timespan] or [scriptblock] is faster than the expected [timespan].

SYNTAX​

Should-BeFasterThan [[-Actual] <Object>] [[-Expected] <Object>] [<CommonParameters>]

DESCRIPTION​

{{ Fill in the Description }}

EXAMPLES​

EXAMPLE 1​

Measure-Command { Start-Sleep -Milliseconds 100 } | Should-BeFasterThan 1s

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

EXAMPLE 2​

{ Start-Sleep -Milliseconds 100 } | Should-BeFasterThan 50ms

This assertion will fail, because the actual value is not faster 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

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-BeFasterThan assertion is the opposite of the Should-BeSlowerThan assertion.

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

https://pester.dev/docs/assertions

VERSION​

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