Add because to should-befasterthan (#2620)

pester · Feb 20, 2025 · 52b044d · 52b044d
1 parent 3808d3c
commit 52b044d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/src/functions/assert/Time/Should-BeFasterThan.ps1 b/src/functions/assert/Time/Should-BeFasterThan.ps1
@@ -40,7 +40,8 @@
         [Parameter(Position = 1, ValueFromPipeline = $true)]
         $Actual,
         [Parameter(Position = 0)]
-        $Expected
+        $Expected,
+        [string] $Because
     )
 
     if ($Expected -isnot [timespan]) {

diff --git a/tst/functions/assert/Time/Should-BeFasterThan.Tests.ps1 b/tst/functions/assert/Time/Should-BeFasterThan.Tests.ps1
@@ -47,4 +47,10 @@ Describe "Should-BeFasterThan" {
     ) {
         { $Actual | Should-BeFasterThan -Expected $Expected } | Verify-AssertionFailed
     }
+
+    It "Has Because parameter" -ForEach @(
+        @{ Actual = { Start-Sleep -Milliseconds 10 }; Expected = "1ms"; Because = "I said so" }
+    ) {
+        { $Actual | Should-BeFasterThan -Expected $Expected -Because $Because } | Verify-AssertionFailed
+    }
 }