Should-BeAfter
Contributions are welcome in Pester-repo.
SYNOPSIS
Asserts that the provided [datetime] is after the expected [datetime].
SYNTAX
Now (Default)
Should-BeAfter [[-Actual] <Object>] [-Now] [-Because <String>] [<CommonParameters>]
FluentFromNow
Should-BeAfter [[-Actual] <Object>] [[-Time] <String>] [-FromNow] [-Because <String>] [<CommonParameters>]
FluentAgo
Should-BeAfter [[-Actual] <Object>] [[-Time] <String>] [-Ago] [-Because <String>] [<CommonParameters>]
Expected
Should-BeAfter [[-Actual] <Object>] [[-Expected] <DateTime>] [-Because <String>] [<CommonParameters>]
DESCRIPTION
This assertion accepts either an expected [datetime] or a fluent relative time expression.
Use -Now, -Ago, or -FromNow to compare against the current local time.
EXAMPLES
EXAMPLE 1
(Get-Date).AddDays(1) | Should-BeAfter (Get-Date)
This assertion will pass, because the actual value is after the expected value.
EXAMPLE 2
(Get-Date).AddDays(-1) | Should-BeAfter (Get-Date)
This assertion will fail, because the actual value is not after the expected value.
EXAMPLE 3
(Get-Date).AddDays(1) | Should-BeAfter 10minutes -FromNow
This assertion will pass, because the actual value is after the expected value.
EXAMPLE 4
(Get-Date).AddDays(-1) | Should-BeAfter -Time 3days -Ago
This assertion will pass, because the actual value is after the expected value.
PARAMETERS
-Actual
The actual [datetime] value.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Now
Indicates that the current time should be used as the expected time.
Type: SwitchParameter
Parameter Sets: Now
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Time
The time to add or subtract from the current time. This parameter uses fluent time syntax e.g. 1minute.
Type: String
Parameter Sets: FluentFromNow, FluentAgo
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Ago
Indicates that the -Time should be subtracted from the current time.
Type: SwitchParameter
Parameter Sets: FluentAgo
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-FromNow
Indicates that the -Time should be added to the current time.
Type: SwitchParameter
Parameter Sets: FluentFromNow
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Expected
The expected [datetime] value.
Type: DateTime
Parameter Sets: Expected
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 after 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-BeAfter assertion is the opposite of the Should-BeBefore 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-BeAfter
https://pester.dev/docs/assertions
VERSION
This page was generated using comment-based help in Pester 6.0.0-rc5.