Project

PSPublishModule

Build, test, version, sign, and publish PowerShell modules with reusable PowerForge pipelines.

Stars 48
Forks 16
PowerShell Gallery downloads 17,213
Release v3.0.169
Language: C# Updated: 2026-10-13

API Reference

Command

Add-BenchmarkComparison

Namespace PSPublishModule
Inputs
None

Adds a benchmark comparison definition.

Remarks

Adds a benchmark comparison definition.

Examples

Authored help example

EXAMPLE 1


Add-BenchmarkComparison -Baseline 'Value'
        

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Add-BenchmarkComparison -Baseline <String> [-Dimension <String>] [-Metric <String[]>] [-RequireBaselineFastest] [-TieTolerance <Double>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Baseline String requiredposition: namedpipeline: False
Baseline value.
Dimension String optionalposition: 0pipeline: False
Dimension to compare.
Metric String[] optionalposition: namedpipeline: False
Metric names.
RequireBaselineFastest SwitchParameter optionalposition: namedpipeline: False
Fail the benchmark when the baseline is materially slower than a successful competitor.
TieTolerance Double optionalposition: namedpipeline: False
Fractional tolerance used to label practically equivalent results, such as 0.05 for five percent.