From 4f4211747a3360833694ad7cb6978f1cefdd73cd Mon Sep 17 00:00:00 2001 From: fflaten <3436158+fflaten@users.noreply.github.com> Date: Sun, 17 Nov 2024 12:25:46 +0000 Subject: [PATCH] Update generated docs to 5.6.1 --- .../commands/Add-ShouldOperator.mdx | 20 ++- .../version-v5/commands/AfterAll.mdx | 20 ++- .../version-v5/commands/AfterEach.mdx | 20 ++- .../version-v5/commands/Assert-MockCalled.mdx | 23 +++- .../commands/Assert-VerifiableMock.mdx | 20 ++- .../version-v5/commands/BeforeAll.mdx | 20 ++- .../version-v5/commands/BeforeDiscovery.mdx | 20 ++- .../version-v5/commands/BeforeEach.mdx | 20 ++- .../version-v5/commands/Context.mdx | 20 ++- .../commands/ConvertTo-JUnitReport.mdx | 20 ++- .../commands/ConvertTo-NUnitReport.mdx | 21 ++- .../commands/ConvertTo-Pester4Result.mdx | 20 ++- .../version-v5/commands/Describe.mdx | 20 ++- .../commands/Export-JUnitReport.mdx | 20 ++- .../commands/Export-NUnitReport.mdx | 21 ++- .../commands/Get-ShouldOperator.mdx | 20 ++- .../version-v5/commands/InModuleScope.mdx | 20 ++- .../version-v5/commands/Invoke-Pester.mdx | 24 +++- versioned_docs/version-v5/commands/It.mdx | 25 +++- versioned_docs/version-v5/commands/Mock.mdx | 20 ++- .../version-v5/commands/New-Fixture.mdx | 20 ++- .../version-v5/commands/New-MockObject.mdx | 26 +++- .../commands/New-PesterConfiguration.mdx | 20 ++- .../commands/New-PesterContainer.mdx | 24 +++- .../version-v5/commands/Set-ItResult.mdx | 24 +++- versioned_docs/version-v5/commands/Should.mdx | 121 ++++++++++-------- .../version-v5/usage/configuration.mdx | 2 +- 27 files changed, 539 insertions(+), 112 deletions(-) diff --git a/versioned_docs/version-v5/commands/Add-ShouldOperator.mdx b/versioned_docs/version-v5/commands/Add-ShouldOperator.mdx index b56e144..82ad8ad 100644 --- a/versioned_docs/version-v5/commands/Add-ShouldOperator.mdx +++ b/versioned_docs/version-v5/commands/Add-ShouldOperator.mdx @@ -24,7 +24,7 @@ Register a Should Operator with Pester ```powershell Add-ShouldOperator [-Name] [-Test] [[-Alias] ] [[-InternalName] ] - [-SupportsArrayInput] [] + [-SupportsArrayInput] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -150,6 +150,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -166,4 +182,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/AfterAll.mdx b/versioned_docs/version-v5/commands/AfterAll.mdx index 66f2e67..e1754c2 100644 --- a/versioned_docs/version-v5/commands/AfterAll.mdx +++ b/versioned_docs/version-v5/commands/AfterAll.mdx @@ -24,7 +24,7 @@ Context or Describe block. ## SYNTAX ```powershell -AfterAll [-Scriptblock] [] +AfterAll [-Scriptblock] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -89,6 +89,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -107,4 +123,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/AfterEach.mdx b/versioned_docs/version-v5/commands/AfterEach.mdx index 49b971e..954e169 100644 --- a/versioned_docs/version-v5/commands/AfterEach.mdx +++ b/versioned_docs/version-v5/commands/AfterEach.mdx @@ -24,7 +24,7 @@ the current Context or Describe block. ## SYNTAX ```powershell -AfterEach [-Scriptblock] [] +AfterEach [-Scriptblock] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -86,6 +86,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -104,4 +120,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Assert-MockCalled.mdx b/versioned_docs/version-v5/commands/Assert-MockCalled.mdx index 5e22780..25b54f8 100644 --- a/versioned_docs/version-v5/commands/Assert-MockCalled.mdx +++ b/versioned_docs/version-v5/commands/Assert-MockCalled.mdx @@ -30,14 +30,15 @@ USE Should -Invoke INSTEAD. ```powershell Assert-MockCalled [-CommandName] [[-Times] ] [-ParameterFilter ] - [-ModuleName ] [-Scope ] [-Exactly] [] + [-ModuleName ] [-Scope ] [-Exactly] [-ProgressAction ] [] ``` ### ExclusiveFilter ```powershell Assert-MockCalled [-CommandName] [[-Times] ] [-ParameterFilter ] - -ExclusiveFilter [-ModuleName ] [-Scope ] [-Exactly] [] + -ExclusiveFilter [-ModuleName ] [-Scope ] [-Exactly] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -168,6 +169,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -184,4 +201,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Assert-VerifiableMock.mdx b/versioned_docs/version-v5/commands/Assert-VerifiableMock.mdx index 0d38d15..55c7730 100644 --- a/versioned_docs/version-v5/commands/Assert-VerifiableMock.mdx +++ b/versioned_docs/version-v5/commands/Assert-VerifiableMock.mdx @@ -26,7 +26,7 @@ USE Should -InvokeVerifiable INSTEAD. ## SYNTAX ```powershell -Assert-VerifiableMock [] +Assert-VerifiableMock [-ProgressAction ] [] ``` ## DESCRIPTION @@ -45,6 +45,22 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -61,4 +77,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/BeforeAll.mdx b/versioned_docs/version-v5/commands/BeforeAll.mdx index 2f43f3c..2c8dbcb 100644 --- a/versioned_docs/version-v5/commands/BeforeAll.mdx +++ b/versioned_docs/version-v5/commands/BeforeAll.mdx @@ -24,7 +24,7 @@ Context or Describe block. ## SYNTAX ```powershell -BeforeAll [-Scriptblock] [] +BeforeAll [-Scriptblock] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -98,6 +98,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -116,4 +132,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/BeforeDiscovery.mdx b/versioned_docs/version-v5/commands/BeforeDiscovery.mdx index 9d58752..baad56f 100644 --- a/versioned_docs/version-v5/commands/BeforeDiscovery.mdx +++ b/versioned_docs/version-v5/commands/BeforeDiscovery.mdx @@ -23,7 +23,7 @@ Runs setup code that is used during Discovery phase. ## SYNTAX ```powershell -BeforeDiscovery [-ScriptBlock] [] +BeforeDiscovery [-ScriptBlock] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -76,6 +76,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -94,4 +110,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/BeforeEach.mdx b/versioned_docs/version-v5/commands/BeforeEach.mdx index 88015aa..b1d97e9 100644 --- a/versioned_docs/version-v5/commands/BeforeEach.mdx +++ b/versioned_docs/version-v5/commands/BeforeEach.mdx @@ -24,7 +24,7 @@ the current Context or Describe block. ## SYNTAX ```powershell -BeforeEach [-Scriptblock] [] +BeforeEach [-Scriptblock] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -83,6 +83,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -101,4 +117,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Context.mdx b/versioned_docs/version-v5/commands/Context.mdx index 4b2013b..ca3150d 100644 --- a/versioned_docs/version-v5/commands/Context.mdx +++ b/versioned_docs/version-v5/commands/Context.mdx @@ -24,7 +24,7 @@ Provides logical grouping of It blocks within a single Describe block. ```powershell Context [-Name] [-Tag ] [[-Fixture] ] [-Skip] [-ForEach ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -161,6 +161,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -183,4 +199,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/ConvertTo-JUnitReport.mdx b/versioned_docs/version-v5/commands/ConvertTo-JUnitReport.mdx index 09fb6e6..cb6e421 100644 --- a/versioned_docs/version-v5/commands/ConvertTo-JUnitReport.mdx +++ b/versioned_docs/version-v5/commands/ConvertTo-JUnitReport.mdx @@ -23,7 +23,7 @@ Converts a Pester result-object to an JUnit-compatible XML report ## SYNTAX ```powershell -ConvertTo-JUnitReport [-Result] [-AsString] [] +ConvertTo-JUnitReport [-Result] [-AsString] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -100,6 +100,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -118,4 +134,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/ConvertTo-NUnitReport.mdx b/versioned_docs/version-v5/commands/ConvertTo-NUnitReport.mdx index 6850dd8..f14585a 100644 --- a/versioned_docs/version-v5/commands/ConvertTo-NUnitReport.mdx +++ b/versioned_docs/version-v5/commands/ConvertTo-NUnitReport.mdx @@ -23,7 +23,8 @@ Converts a Pester result-object to an NUnit 2.5 or 3-compatible XML-report ## SYNTAX ```powershell -ConvertTo-NUnitReport [-Result] [-AsString] [[-Format] ] [] +ConvertTo-NUnitReport [-Result] [-AsString] [[-Format] ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -127,6 +128,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -145,4 +162,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/ConvertTo-Pester4Result.mdx b/versioned_docs/version-v5/commands/ConvertTo-Pester4Result.mdx index d515ed7..8495975 100644 --- a/versioned_docs/version-v5/commands/ConvertTo-Pester4Result.mdx +++ b/versioned_docs/version-v5/commands/ConvertTo-Pester4Result.mdx @@ -23,7 +23,7 @@ Converts a Pester 5 result-object to an Pester 4-compatible object ## SYNTAX ```powershell -ConvertTo-Pester4Result [-PesterResult] [] +ConvertTo-Pester4Result [-PesterResult] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -68,6 +68,22 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -86,4 +102,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Describe.mdx b/versioned_docs/version-v5/commands/Describe.mdx index fcf8202..6a2b00f 100644 --- a/versioned_docs/version-v5/commands/Describe.mdx +++ b/versioned_docs/version-v5/commands/Describe.mdx @@ -24,7 +24,7 @@ Creates a logical group of tests. ```powershell Describe [-Name] [-Tag ] [[-Fixture] ] [-Skip] [-ForEach ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -171,6 +171,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -193,4 +209,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Export-JUnitReport.mdx b/versioned_docs/version-v5/commands/Export-JUnitReport.mdx index 74665c5..b536189 100644 --- a/versioned_docs/version-v5/commands/Export-JUnitReport.mdx +++ b/versioned_docs/version-v5/commands/Export-JUnitReport.mdx @@ -23,7 +23,7 @@ Exports a Pester result-object to an JUnit-compatible XML-report ## SYNTAX ```powershell -Export-JUnitReport [-Result] [-Path] [] +Export-JUnitReport [-Result] [-Path] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -87,6 +87,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -105,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Export-NUnitReport.mdx b/versioned_docs/version-v5/commands/Export-NUnitReport.mdx index 7f0b487..785a91c 100644 --- a/versioned_docs/version-v5/commands/Export-NUnitReport.mdx +++ b/versioned_docs/version-v5/commands/Export-NUnitReport.mdx @@ -23,7 +23,8 @@ Exports a Pester result-object to an NUnit-compatible XML-report ## SYNTAX ```powershell -Export-NUnitReport [-Result] [-Path] [[-Format] ] [] +Export-NUnitReport [-Result] [-Path] [[-Format] ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -103,6 +104,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -121,4 +138,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Get-ShouldOperator.mdx b/versioned_docs/version-v5/commands/Get-ShouldOperator.mdx index 1b9b576..7e29171 100644 --- a/versioned_docs/version-v5/commands/Get-ShouldOperator.mdx +++ b/versioned_docs/version-v5/commands/Get-ShouldOperator.mdx @@ -23,7 +23,7 @@ Display the assertion operators available for use with Should. ## SYNTAX ```powershell -Get-ShouldOperator [-Name ] [] +Get-ShouldOperator [-ProgressAction ] [-Name ] [] ``` ## DESCRIPTION @@ -71,6 +71,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -94,4 +110,4 @@ standard PowerShell discovery patterns (like `Get-Help Should -Parameter *`). ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/InModuleScope.mdx b/versioned_docs/version-v5/commands/InModuleScope.mdx index 8a1afbe..bff24dd 100644 --- a/versioned_docs/version-v5/commands/InModuleScope.mdx +++ b/versioned_docs/version-v5/commands/InModuleScope.mdx @@ -25,7 +25,7 @@ scope of a PowerShell script or manifest module. ```powershell InModuleScope [-ModuleName] [-ScriptBlock] [[-Parameters] ] - [[-ArgumentList] ] [] + [[-ArgumentList] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -188,6 +188,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -204,4 +220,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Invoke-Pester.mdx b/versioned_docs/version-v5/commands/Invoke-Pester.mdx index 59c7806..19ff398 100644 --- a/versioned_docs/version-v5/commands/Invoke-Pester.mdx +++ b/versioned_docs/version-v5/commands/Invoke-Pester.mdx @@ -27,7 +27,7 @@ Runs Pester tests ```powershell Invoke-Pester [[-Path] ] [-ExcludePath ] [-TagFilter ] [-ExcludeTagFilter ] [-FullNameFilter ] [-CI] [-Output ] [-PassThru] - [-Container ] [] + [-Container ] [-ProgressAction ] [] ``` ### Legacy @@ -37,13 +37,13 @@ Invoke-Pester [[-Path] ] [-TagFilter ] [-ExcludeTagFilter ] [-PassThru] [-EnableExit] [-CodeCoverage ] [-CodeCoverageOutputFile ] [-CodeCoverageOutputFileEncoding ] [-CodeCoverageOutputFileFormat ] [-Strict] [-OutputFile ] [-OutputFormat ] [-Quiet] - [-PesterOption ] [-Show ] [] + [-PesterOption ] [-Show ] [-ProgressAction ] [] ``` ### Advanced ```powershell -Invoke-Pester [-Configuration ] [] +Invoke-Pester [-Configuration ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -635,6 +635,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -653,4 +669,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/It.mdx b/versioned_docs/version-v5/commands/It.mdx index 5471235..aff0c86 100644 --- a/versioned_docs/version-v5/commands/It.mdx +++ b/versioned_docs/version-v5/commands/It.mdx @@ -25,21 +25,22 @@ Validates the results of a test inside of a Describe block. ### Normal (Default) ```powershell -It [-Name] [[-Test] ] [-ForEach ] [-Tag ] [] +It [-Name] [[-Test] ] [-ForEach ] [-Tag ] + [-ProgressAction ] [] ``` ### Pending ```powershell It [-Name] [[-Test] ] [-ForEach ] [-Tag ] [-Pending] - [] + [-ProgressAction ] [] ``` ### Skip ```powershell It [-Name] [[-Test] ] [-ForEach ] [-Tag ] [-Skip] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -240,6 +241,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -262,4 +279,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Mock.mdx b/versioned_docs/version-v5/commands/Mock.mdx index 5b75de8..3c2f8e2 100644 --- a/versioned_docs/version-v5/commands/Mock.mdx +++ b/versioned_docs/version-v5/commands/Mock.mdx @@ -26,7 +26,7 @@ implementation. ```powershell Mock [[-CommandName] ] [[-MockWith] ] [-Verifiable] [[-ParameterFilter] ] [[-ModuleName] ] [[-RemoveParameterType] ] [[-RemoveParameterValidation] ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -321,6 +321,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -339,4 +355,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/New-Fixture.mdx b/versioned_docs/version-v5/commands/New-Fixture.mdx index 2fde74a..a205d14 100644 --- a/versioned_docs/version-v5/commands/New-Fixture.mdx +++ b/versioned_docs/version-v5/commands/New-Fixture.mdx @@ -24,7 +24,7 @@ and another one that contains its tests. ## SYNTAX ```powershell -New-Fixture [-Name] [[-Path] ] [] +New-Fixture [-Name] [[-Path] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -118,6 +118,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -142,4 +158,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/New-MockObject.mdx b/versioned_docs/version-v5/commands/New-MockObject.mdx index 5cf702a..4e4658c 100644 --- a/versioned_docs/version-v5/commands/New-MockObject.mdx +++ b/versioned_docs/version-v5/commands/New-MockObject.mdx @@ -26,14 +26,14 @@ This function instantiates a .NET object from a type. ```powershell New-MockObject [-Type] [-Properties ] [-Methods ] [-MethodHistoryPrefix ] - [] + [-ProgressAction ] [] ``` ### InputObject ```powershell New-MockObject -InputObject [-Properties ] [-Methods ] - [-MethodHistoryPrefix ] [] + [-MethodHistoryPrefix ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -123,7 +123,7 @@ Accept wildcard characters: False ### -Properties -Properties to define, specified as a hashtable, in format `@{ PropertyName = value }`. +Properties to define, specified as a hashtable, in format `@\{ PropertyName = value \}`. ```yaml Type: Hashtable @@ -139,7 +139,7 @@ Accept wildcard characters: False ### -Methods -Methods to define, specified as a hashtable, in format `@{ MethodName = scriptBlock }`. +Methods to define, specified as a hashtable, in format `@\{ MethodName = scriptBlock \}`. ScriptBlock can define param block, and it will receive arguments that were provided to the function call based on order. @@ -176,6 +176,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -194,4 +210,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/New-PesterConfiguration.mdx b/versioned_docs/version-v5/commands/New-PesterConfiguration.mdx index 1ce368f..e4869b1 100644 --- a/versioned_docs/version-v5/commands/New-PesterConfiguration.mdx +++ b/versioned_docs/version-v5/commands/New-PesterConfiguration.mdx @@ -23,7 +23,7 @@ Creates a new PesterConfiguration object for advanced configuration of Invoke-Pe ## SYNTAX ```powershell -New-PesterConfiguration [[-Hashtable] ] [] +New-PesterConfiguration [[-Hashtable] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -252,6 +252,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -272,4 +288,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/New-PesterContainer.mdx b/versioned_docs/version-v5/commands/New-PesterContainer.mdx index 127f524..c218492 100644 --- a/versioned_docs/version-v5/commands/New-PesterContainer.mdx +++ b/versioned_docs/version-v5/commands/New-PesterContainer.mdx @@ -25,13 +25,15 @@ Generates ContainerInfo-objects used as for Invoke-Pester -Container ### Path (Default) ```powershell -New-PesterContainer -Path [-Data ] [] +New-PesterContainer -Path [-Data ] [-ProgressAction ] + [] ``` ### ScriptBlock ```powershell -New-PesterContainer -ScriptBlock [-Data ] [] +New-PesterContainer -ScriptBlock [-Data ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -132,6 +134,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -152,4 +170,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Set-ItResult.mdx b/versioned_docs/version-v5/commands/Set-ItResult.mdx index 3728c80..5a91400 100644 --- a/versioned_docs/version-v5/commands/Set-ItResult.mdx +++ b/versioned_docs/version-v5/commands/Set-ItResult.mdx @@ -25,19 +25,19 @@ Set-ItResult is used inside the It block to explicitly set the test result ### Inconclusive ```powershell -Set-ItResult [-Inconclusive] [-Because ] [] +Set-ItResult [-Inconclusive] [-Because ] [-ProgressAction ] [] ``` ### Pending ```powershell -Set-ItResult [-Pending] [-Because ] [] +Set-ItResult [-Pending] [-Because ] [-ProgressAction ] [] ``` ### Skipped ```powershell -Set-ItResult [-Skipped] [-Because ] [] +Set-ItResult [-Skipped] [-Because ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -147,6 +147,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +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](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -163,4 +179,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/commands/Should.mdx b/versioned_docs/version-v5/commands/Should.mdx index 2f5fef4..0af229b 100644 --- a/versioned_docs/version-v5/commands/Should.mdx +++ b/versioned_docs/version-v5/commands/Should.mdx @@ -25,180 +25,185 @@ Should is a keyword that is used to define an assertion inside an It block. ### Be ```powershell -Should [[-ActualValue] ] [-Be] [-Not] [-ExpectedValue ] [-Because ] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Be] [-Not] [-ExpectedValue ] + [-Because ] [] ``` ### BeExactly ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-BeExactly] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-BeExactly] [] ``` ### BeGreaterThan ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-BeGreaterThan] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-BeGreaterThan] [] ``` ### BeLessOrEqual ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-BeLessOrEqual] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-BeLessOrEqual] [] ``` ### BeIn ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-BeIn] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-BeIn] [] ``` ### BeLessThan ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-BeLessThan] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-BeLessThan] [] ``` ### BeGreaterOrEqual ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-BeGreaterOrEqual] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-BeGreaterOrEqual] [] ``` ### BeLike ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-BeLike] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-BeLike] [] ``` ### BeLikeExactly ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-BeLikeExactly] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-BeLikeExactly] [] ``` ### BeNullOrEmpty ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-BeNullOrEmpty] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] + [-BeNullOrEmpty] [] ``` ### BeOfType ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-BeOfType] [-ExpectedType ] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] [-BeOfType] + [-ExpectedType ] [] ``` ### BeTrue ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-BeTrue] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] [-BeTrue] + [] ``` ### BeFalse ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-BeFalse] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] [-BeFalse] + [] ``` ### Contain ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-Contain] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-Contain] [] ``` ### Exist ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-Exist] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] [-Exist] + [] ``` ### FileContentMatch ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-FileContentMatch] [-ExpectedContent ] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] + [-FileContentMatch] [-ExpectedContent ] [] ``` ### FileContentMatchExactly ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-ExpectedContent ] - [-FileContentMatchExactly] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] + [-ExpectedContent ] [-FileContentMatchExactly] [] ``` ### FileContentMatchMultiline ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-ExpectedContent ] - [-FileContentMatchMultiline] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] + [-ExpectedContent ] [-FileContentMatchMultiline] [] ``` ### FileContentMatchMultilineExactly ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-ExpectedContent ] - [-FileContentMatchMultilineExactly] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] + [-ExpectedContent ] [-FileContentMatchMultilineExactly] [] ``` ### HaveCount ```powershell -Should [[-ActualValue] ] [-Not] [-ExpectedValue ] [-Because ] [-HaveCount] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-ExpectedValue ] + [-Because ] [-HaveCount] [] ``` ### HaveParameter ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-HaveParameter] [-ParameterName ] - [-Type ] [-DefaultValue ] [-Mandatory] [-InParameterSet ] [-HasArgumentCompleter] - [-Alias ] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] + [-HaveParameter] [-ParameterName ] [-Type ] [-DefaultValue ] [-Mandatory] + [-InParameterSet ] [-HasArgumentCompleter] [-Alias ] [] ``` ### Match ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-Match] [-RegularExpression ] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] [-Match] + [-RegularExpression ] [] ``` ### MatchExactly ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-RegularExpression ] [-MatchExactly] - [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] + [-RegularExpression ] [-MatchExactly] [] ``` ### Throw ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-Throw] [-ExpectedMessage ] - [-ErrorId ] [-ExceptionType ] [-PassThru] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] [-Throw] + [-ExpectedMessage ] [-ErrorId ] [-ExceptionType ] [-PassThru] [] ``` ### InvokeVerifiable ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-InvokeVerifiable] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] + [-InvokeVerifiable] [] ``` ### Invoke ```powershell -Should [[-ActualValue] ] [-Not] [-Because ] [-Invoke] [-CommandName ] [-Times ] - [-ParameterFilter ] [-ExclusiveFilter ] [-ModuleName ] [-Scope ] [-Exactly] - [-CallerSessionState ] [] +Should [[-ActualValue] ] [-ProgressAction ] [-Not] [-Because ] [-Invoke] + [-CommandName ] [-Times ] [-ParameterFilter ] [-ExclusiveFilter ] + [-ModuleName ] [-Scope ] [-Exactly] [-CallerSessionState ] [] ``` ## DESCRIPTION @@ -1078,6 +1083,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction + +\{\{ Fill ProgressAction Description \}\} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RegularExpression Depends on operator being used. @@ -1181,4 +1202,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).* diff --git a/versioned_docs/version-v5/usage/configuration.mdx b/versioned_docs/version-v5/usage/configuration.mdx index c51f1f6..a89d076 100644 --- a/versioned_docs/version-v5/usage/configuration.mdx +++ b/versioned_docs/version-v5/usage/configuration.mdx @@ -128,7 +128,7 @@ Tests Passed: 1, Failed: 0, Skipped: 0, Total: 1, NotRun: 0 -*This section was generated using Pester 5.6.0.* +*This section was generated using Pester 5.6.1.* ### Run