Skip to content

📖 [Docs]: README pages now use the standard module landing-page format #35

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

Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
base: main
Choose a base branch
from
Open

📖 [Docs]: README pages now use the standard module landing-page format #35

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed856e4
Standardize README landing page
MariusStorhaug Jul 6, 2026
1b5fb79
Address Copilot README review
MariusStorhaug Jul 6, 2026
ab3e3d2
Address Copilot README review
MariusStorhaug Jul 6, 2026
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
153 changes: 11 additions & 142 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,165 +1,34 @@
# DynamicParams

A PowerShell module that makes it easier to use dynamic params.

## Prerequisites

No prerequisites are required to use this module.
DynamicParams is a PowerShell module that makes it easier to build dynamic parameters.

## Installation

Provide step-by-step instructions on how to install the module, including any InstallModule commands or manual installation steps.
Install the module from the PowerShell Gallery:

```powershell
Install-Module -Name DynamicParams
Comment thread
Copilot marked this conversation as resolved.
Import-Module -Name DynamicParams
```

## Usage

Here is a list of example that are typical use cases for the module.
This section should provide a good overview of the module's capabilities.

### Use dynamic parameters in a function

Here is an example of how to use dynamic parameters in a function.
Or with PSResourceGet:

```powershell
#Requires -Modules DynamicParams

function Get-Info {
[CmdletBinding()]
param ()

dynamicparam {
$DynamicParamDictionary = New-DynamicParamDictionary

$dynParam = @{
Name = 'Process'
Alias = 'proc'
Type = [string]
ValidateSet = Get-Process | Select-Object -ExpandProperty Name -Unique
DynamicParamDictionary = $DynamicParamDictionary
}
New-DynamicParam @dynParam

$dynParam2 = @{
Name = 'Service'
Alias = 'svc'
Type = [string]
ValidateSet = Get-Service | Select-Object -ExpandProperty Name -Unique
DynamicParamDictionary = $DynamicParamDictionary
}
New-DynamicParam @dynParam2

return $DynamicParamDictionary
}

...
process {
$process = $PSBoundParameters['Process']
$service = $PSBoundParameters['Service']
...
}
...
}

Install-PSResource -Name DynamicParams
Import-Module -Name DynamicParams
```
Comment thread
MariusStorhaug marked this conversation as resolved.

### Use dynamic parameters in a function - DSL Style

Here is an example of how to use dynamic parameters in a function.

```powershell
#Requires -Modules DynamicParams

function Get-Info {
[CmdletBinding()]
param ()
## Documentation

dynamicparam {
DynamicParams @(
@{
Name = 'Process'
Alias = 'proc'
Type = [string]
ValidateSet = Get-Process | Select-Object -ExpandProperty Name -Unique
}
@{
Name = 'Service'
Alias = 'svc'
Type = [string]
ValidateSet = Get-Service | Select-Object -ExpandProperty Name -Unique
}
)
}
Documentation is published at [psmodule.io/DynamicParams](https://psmodule.io/DynamicParams/).

...
process {
$process = $PSBoundParameters['Process']
$service = $PSBoundParameters['Service']
...
}
...
}

```

### Use dynamic parameters in a function - Pipeline style

Here is an example of how to use dynamic parameters in a function.
Use PowerShell help and command discovery for module details:

```powershell
#Requires -Modules DynamicParams

function Get-Info {
[CmdletBinding()]
param ()

dynamicparam {
$params = @(
@{
Name = 'Variable'
Type = [string]
ValidateSet = Get-Variable | Select-Object -ExpandProperty Name
},
@{
Name = 'EnvironmentVariable'
Type = [string]
ValidateSet = Get-ChildItem -Path env: | Select-Object -ExpandProperty Name
}
)

$params | ForEach-Object { New-DynamicParam @_ } | New-DynamicParamDictionary
}

...
process {
$process = $PSBoundParameters['Process']
$service = $PSBoundParameters['Service']
...
}
...
}

Get-Command -Module DynamicParams
Get-Help New-DynamicParam -Examples
```


## Contributing

Coder or not, you can contribute to the project! We welcome all contributions.

### For Users

If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
Please see the issues tab on this project and submit a new issue that matches your needs.

### For Developers

If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement.

## Links

- [about_Functions_Advanced_Parameters | Microsoft Learn](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_functions_advanced_parameters?view=powershell-7.4#dynamic-parameters)
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.
Loading