< Summary - Kestrun — Combined Coverage

Information

Class:	Private.Logging.Write-KrError
Assembly:	Kestrun.PowerShell.Private
File(s):	/home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Private/Logging/Write-KrError.ps1
Tag:	Kestrun/Kestrun@ca54e35c77799b76774b3805b6f075cdbc0c5fbe

Line coverage

Branch coverage

N/A

Method coverage

Feature is only available for sponsors

Coverage history

Method
Write-KrError()

#	Line	Line coverage
	`1`	`<#`
	`2`	`.SYNOPSIS`
	`3`	`Logs an error message and optionally stops the Kestrun server.`
	`4`	`.DESCRIPTION`
	`5`	`This function logs an error message using the Kestrun logging framework. If the Terminate switch is specified, it wi`
	`6`	`.PARAMETER FunctionName`
	`7`	`The name of the function or cmdlet where the error occurred. Defaults to the current invocation name.`
	`8`	`.PARAMETER ErrorMessage`
	`9`	`The error message to log.`
	`10`	`.PARAMETER Terminate`
	`11`	`If specified, the function will stop the Kestrun server after logging the error.`
	`12`	`.EXAMPLE`
	`13`	`Write-KrError -FunctionName 'Start-KrServer' -ErrorMessage 'Failed to start the server.' -Terminate`
	`14`	`This example logs an error message indicating that the server failed to start and then stops the Kestrun server.`
	`15`	`.NOTES`
	`16`	`This function is intended for internal use within the Kestrun framework.`
	`17`	`#>`
	`18`	`function Write-KrError {`
	`19`	`param (`
	`20`	`[string]$FunctionName = $PSCmdlet.MyInvocation.InvocationName,`
	`21`	`[string]$ErrorMessage,`
	`22`	`[switch]$Terminate`
	`23`	`)`
0	`24`	`if (Test-KrLogger) {`
0	`25`	`Write-KrLog -Level Error -Message '{function}: {message}' -Values $FunctionName, $ErrorMessage`
	`26`	`} else {`
0	`27`	`Write-Warning -Message "$($FunctionName): $ErrorMessage"`
	`28`	`}`
0	`29`	`if ($Terminate) {`
0	`30`	`Stop-KrServer -NoWait`
	`31`	`}`
	`32`	`}`