Should-BeBefore

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS

Asserts that the provided [datetime] is before the expected [datetime].

SYNTAX

Now (Default)

Should-BeBefore [[-Actual] <Object>] [-Now] [-Because <String>] [<CommonParameters>]

FluentFromNow

Should-BeBefore [[-Actual] <Object>] [[-Time] <String>] [-FromNow] [-Because <String>] [<CommonParameters>]

FluentAgo

Should-BeBefore [[-Actual] <Object>] [[-Time] <String>] [-Ago] [-Because <String>] [<CommonParameters>]

Expected

Should-BeBefore [[-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-BeBefore (Get-Date)

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

EXAMPLE 2

(Get-Date).AddDays(1) | Should-BeBefore (Get-Date)

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

EXAMPLE 3

(Get-Date).AddMinutes(1) | Should-BeBefore 10minutes -FromNow

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

EXAMPLE 4

(Get-Date).AddDays(-2) | Should-BeBefore -Time 3days -Ago

This assertion will pass, because the actual value is before 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 before 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-BeBefore assertion is the opposite of the Should-BeAfter assertion.

RELATED LINKS

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

https://pester.dev/docs/assertions

VERSION

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