Skip to main content
Version: v6 (preview) 🚧

Should-BeEquivalent

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS​

Compares two objects for equivalency, by recursively comparing their properties for equivalency.

SYNTAX​

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

DESCRIPTION​

{{ Fill in the Description }}

EXAMPLES​

EXAMPLE 1​

    $expected = [PSCustomObject] @{
        Name = "Thomas"
    }

    $actual = [PSCustomObject] @{
        Name = "Jakub"
        Age = 30
    }

    $actual | Should-BeEquivalent $expected

This will throw an error because the actual object has an additional property Age and the Name values are not equivalent.

EXAMPLE 2​

    $expected = [PSCustomObject] @{
        Name = "Thomas"
    }

    $actual = [PSCustomObject] @{
        Name = "Thomas"
    }

    $actual | Should-BeEquivalent $expected

This will pass because the actual object has the same properties as the expected object and the Name values are equivalent.

PARAMETERS​

-Actual​

The actual object to compare.

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 object to compare.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Because​

The reason why the input should be the expected value.

Type: String
Parameter Sets: (All)
Aliases:

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

-Options​

Options for the comparison. Get-EquivalencyOption function is called to get the default options.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: (Get-EquivalencyOption)
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​

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

https://pester.dev/docs/assertions

VERSION​

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