| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Retrieves a query parameter value from the HTTP request. |
| | | 4 | | .DESCRIPTION |
| | | 5 | | This function accesses the current HTTP request context and retrieves the value |
| | | 6 | | of the specified query parameter by name. |
| | | 7 | | .PARAMETER Name |
| | | 8 | | The name of the query parameter to retrieve from the HTTP request. |
| | | 9 | | .PARAMETER AsInt |
| | | 10 | | If specified, converts the query parameter value to an integer. |
| | | 11 | | .PARAMETER AsBool |
| | | 12 | | If specified, converts the query parameter value to a boolean. |
| | | 13 | | .PARAMETER AsDouble |
| | | 14 | | If specified, converts the query parameter value to a double. |
| | | 15 | | .PARAMETER AsString |
| | | 16 | | If specified, converts the query parameter value to a string. |
| | | 17 | | .PARAMETER ThrowIfMissing |
| | | 18 | | If specified, throws an error if the query parameter is not found. |
| | | 19 | | By default, it returns $null if not found. |
| | | 20 | | .EXAMPLE |
| | | 21 | | $value = Get-KrRequestQuery -Name "param1" |
| | | 22 | | Retrieves the value of the query parameter "param1" from the HTTP request. |
| | | 23 | | .EXAMPLE |
| | | 24 | | $id = Get-KrRequestQuery -Name "id" -AsInt -ThrowIfMissing |
| | | 25 | | Retrieves the value of the query parameter "id" as an integer, throwing an error if it's missing. |
| | | 26 | | .EXAMPLE |
| | | 27 | | $flag = Get-KrRequestQuery -Name "flag" -AsBool |
| | | 28 | | Retrieves the value of the query parameter "flag" as a boolean. |
| | | 29 | | .OUTPUTS |
| | | 30 | | Returns the value of the specified query parameter, or $null if not found. |
| | | 31 | | .NOTES |
| | | 32 | | This function is designed to be used in the context of a Kestrun server response. |
| | | 33 | | #> |
| | | 34 | | function Get-KrRequestQuery { |
| | | 35 | | [KestrunRuntimeApi('Route')] |
| | | 36 | | [CmdletBinding(DefaultParameterSetName = 'Default')] |
| | | 37 | | [OutputType([string])] |
| | | 38 | | [OutputType([int])] |
| | | 39 | | [OutputType([bool])] |
| | | 40 | | [OutputType([double])] |
| | | 41 | | [OutputType([object])] |
| | | 42 | | param( |
| | | 43 | | [Parameter(Mandatory = $true)] |
| | | 44 | | [string]$Name, |
| | | 45 | | |
| | | 46 | | [Parameter(parameterSetName = 'Int')] |
| | | 47 | | [switch]$AsInt, |
| | | 48 | | |
| | | 49 | | [Parameter(parameterSetName = 'Bool')] |
| | | 50 | | [Alias('AsBoolean')] |
| | | 51 | | [switch]$AsBool, |
| | | 52 | | |
| | | 53 | | [Parameter(parameterSetName = 'Double')] |
| | | 54 | | [switch]$AsDouble, |
| | | 55 | | |
| | | 56 | | [Parameter(parameterSetName = 'String')] |
| | | 57 | | [switch]$AsString, |
| | | 58 | | |
| | | 59 | | [Parameter()] |
| | | 60 | | [switch]$ThrowIfMissing |
| | | 61 | | ) |
| | 0 | 62 | | if ($null -ne $Context -and $null -ne $Context.Request -and $null -ne $Context.Request.Query) { |
| | 0 | 63 | | if ($ThrowIfMissing -and -not $Context.Request.Query.ContainsKey($Name)) { |
| | 0 | 64 | | throw [System.ArgumentException]::new("Missing required query parameter: $Name") |
| | | 65 | | } |
| | | 66 | | # Get the query parameter value from the request |
| | 0 | 67 | | $value = $Context.Request.Query[$Name] |
| | 0 | 68 | | if ($AsInt) { |
| | 0 | 69 | | return [int]$value |
| | | 70 | | } |
| | 0 | 71 | | if ($AsBool) { |
| | 0 | 72 | | return [bool]$value |
| | | 73 | | } |
| | 0 | 74 | | if ($AsDouble) { |
| | 0 | 75 | | return [double]$value |
| | | 76 | | } |
| | 0 | 77 | | if ($AsString) { |
| | 0 | 78 | | return $value.ToString() |
| | | 79 | | } |
| | 0 | 80 | | return $value |
| | | 81 | | } else { |
| | | 82 | | # Outside of request context |
| | 0 | 83 | | Write-KrOutsideRouteWarning |
| | | 84 | | } |
| | | 85 | | } |