< Summary - Kestrun — Combined Coverage

Information

Class:	Public.Form.Get-KrFormOption
Assembly:	Kestrun.PowerShell.Public
File(s):	/home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/Form/Get-KrFormOption.ps1
Tag:	Kestrun/Kestrun@d9261bd752e45afa789d10bc0c82b7d5724d9589

Line coverage

Branch coverage

N/A

Method coverage

Feature is only available for sponsors

Coverage history

Method
Get-KrFormOption()

#	Line	Line coverage
	`1`	`<#`
	`2`	`.SYNOPSIS`
	`3`	`Retrieves a form option from the Kestrun server.`
	`4`	`.DESCRIPTION`
	`5`	`The Get-KrFormOption function retrieves a Kestrun form option by its name from the server's form options collection.`
	`6`	`.PARAMETER Name`
	`7`	`The name of the form option to retrieve.`
	`8`	`.OUTPUTS`
	`9`	`Kestrun.Forms.KrFormOptions`
	`10`	`.EXAMPLE`
	`11`	`$formOption = Get-KrFormOption -Name 'MyFormOption'`
	`12`	`This example retrieves the form option named 'MyFormOption' from the Kestrun server.`
	`13`	`.NOTES`
	`14`	`This function is part of the Kestrun.Forms module and is used to define form options.`
	`15`	`#>`
	`16`	`function Get-KrFormOption {`
	`17`	`[KestrunRuntimeApi('Definition')]`
	`18`	`[CmdletBinding()]`
	`19`	`[OutputType([Kestrun.Forms.KrFormOptions])]`
	`20`	`param(`
	`21`	`[Parameter(Mandatory = $true)]`
	`22`	`[string] $Name`
	`23`	`)`
0	`24`	`$Server = Resolve-KestrunServer`
	`25`
	`26`	`# Return the form option by name or null if not found`
0	`27`	`return $Server.GetFormOption($Name)`
	`28`	`}`