| external help file | Elizium.Loopz-help.xml |
|---|---|
| Module Name | Elizium.Loopz |
| online version | https://eliziumnet.github.io/Loopz/ |
| schema | 2.0.0 |
Displays information for a commands parameter sets. This includes the standard syntax statement associated with each parameter set, but is also coloured in, to help readability.
Show-ParameterSetInfo [-Name] <String[]> [[-Sets] <String[]>] [-Scribbler <Scribbler>] [-Title <String>]
[-Common] [-Test] [<CommonParameters>]If the command does not define parameter sets, then no information is displayed apart from a message indicating no parameter sets were found.
One of the issues that a developer can encounter when designing parameter sets for a command is making sure that each parameter set includes at least 1 unique parameter as per recommendations. This function will greatly help in this regard. For each parameter set shown, the table it contains includes a 'Unique' column which shows whether a the parameter is unique to that parameter set. This relieves the developer from having to figure this out themselves.
Get-Command 'Rename-Many' | Show-ParameterSetInfo'Rename-Many' | Show-ParameterSetInfo -Common'Rename-Many' | Show-ParameterSetInfo -Sets MoveToAnchor, UpdateInPlaceShow-ParameterSetInfo -Name 'Rename-Many' -Sets MoveToAnchor, UpdateInPlaceswitch to indicate if the standard PowerShell Common parameters should be included
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseItem(s) from the pipeline. Can be command/alias name of the command, or command/alias info obtained via Get-Command.
Type: Array[]
Parameter Sets: ByPipeline
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseThe name of the command to show parameter set info report for. Can be alias or full command name.
Type: String
Parameter Sets: ByName
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe Krayola scribbler instance used to manage rendering to console
Type: Scribbler
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA list of parameter sets the output should be restricted to. When not specified, all parameter sets are displayed.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRequired by unit tests only.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe text displayed as a title. End user does not have to specify this value. It is useful to other client command that invoke this one, so some context can be added to the display.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Parameter $Name, can be CommandInfo derived from get-Command or simply the name of the command as a string. Multiple items can be specified using array notation.