Skip to content

docs(Test-FeatureFlag,Test-Condition): add [OutputType([bool])] and .OUTPUTS help #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HeyItsGilbert merged 1 commit into from
May 14, 2026
Merged

docs(Test-FeatureFlag,Test-Condition): add [OutputType([bool])] and .OUTPUTS help #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Gatekeeper/Public/Test-Condition.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,13 @@ function Test-Condition {
Test-Condition -Context $context -PropertySet $propertySet -Condition $rule

This would return a true/false

.OUTPUTS
System.Boolean
Returns $true if the condition matches the given context, $false otherwise.
#>
[CmdletBinding()]
[OutputType([bool])]
param (
[Parameter(Mandatory)]
[hashtable]
Expand Down
5 changes: 5 additions & 0 deletions Gatekeeper/Public/Test-FeatureFlag.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,13 @@
Test-FeatureFlag -FeatureFlag $flag -PropertySet $propertySet -Context $context

This will test if the current device will pass the feature flag rules.

.OUTPUTS
System.Boolean
Returns $true if an Allow rule matches, $false otherwise.
#>
[CmdletBinding()]
[OutputType([bool])]
param (
[Parameter(Mandatory, ValueFromPipeline)]
[FeatureFlag]
Expand Down
4 changes: 4 additions & 0 deletions docs/en-US/Test-Condition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Check warning on line 89 in docs/en-US/Test-Condition.md

View workflow job for this annotation

GitHub Actions / Continuous Integration / Run Linters 

Unknown word (proga) Suggestions: (proa, prog, progs, Prog, prgo)

Required: False
Position: Named
Expand All @@ -102,6 +102,10 @@

## OUTPUTS

### System.Boolean

Returns $true if the condition matches the given context, $false otherwise.

## NOTES

## RELATED LINKS
4 changes: 4 additions & 0 deletions docs/en-US/Test-FeatureFlag.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Check warning on line 88 in docs/en-US/Test-FeatureFlag.md

View workflow job for this annotation

GitHub Actions / Continuous Integration / Run Linters 

Unknown word (proga) Suggestions: (proa, prog, progs, Prog, prgo)

Required: False
Position: Named
Expand All @@ -101,6 +101,10 @@

## OUTPUTS

### System.Boolean

Returns $true if an Allow rule matches, $false otherwise.

## NOTES

## RELATED LINKS
Loading