Skip to content

Assert-BenchmarkValue.md

Latest commit

 

History

History
134 lines (103 loc) · 2.46 KB

Assert-BenchmarkValue.md

File metadata and controls

134 lines (103 loc) · 2.46 KB
Raw
external help file PSPublishModule-help.xml
Module Name PSPublishModule
online version https://github.com/EvotecIT/PSPublishModule
schema 2.0.0

Assert-BenchmarkValue

SYNOPSIS

Asserts a benchmark value condition.

SYNTAX

Equals (Default)

Assert-BenchmarkValue [-Actual] <Object> [-Expected] <Object> [-Message <string>] [-PassThru] [<CommonParameters>]

NotNull

Assert-BenchmarkValue [-Actual] <Object> -NotNull [-Message <string>] [-PassThru] [<CommonParameters>]

DESCRIPTION

Asserts a benchmark value condition.

EXAMPLES

EXAMPLE 1

Assert-BenchmarkValue -Actual 'Value'

EXAMPLE 2

Assert-BenchmarkValue -NotNull

PARAMETERS

-Actual

Actual value.

Type: Object
Parameter Sets: Equals, NotNull
Aliases: None
Possible values:

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

-Expected

Expected value.

Type: Object
Parameter Sets: Equals
Aliases: None
Possible values:

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

-Message

Optional assertion message.

Type: String
Parameter Sets: Equals, NotNull
Aliases: None
Possible values:

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

-NotNull

Assert that the value is not null.

Type: SwitchParameter
Parameter Sets: NotNull
Aliases: None
Possible values:

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

-PassThru

Emit the actual value when the assertion passes.

Type: SwitchParameter
Parameter Sets: Equals, NotNull
Aliases: None
Possible values:

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

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

  • None

OUTPUTS

  • System.Object

RELATED LINKS

  • None