< Summary - Kestrun — Combined Coverage

Information

Class:	Public.Sse.Start-KrSseResponse
Assembly:	Kestrun.PowerShell.Public
File(s):	/home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/Sse/Start-KrSseResponse.ps1
Tag:	Kestrun/Kestrun@eeafbe813231ed23417e7b339e170e307b2c86f9

Line coverage

Branch coverage

N/A

Method coverage

Feature is only available for sponsors

Coverage history

Method
Start-KrSseResponse()

#	Line	Line coverage
	`1`	`<#`
	`2`	`.SYNOPSIS`
	`3`	`Starts a Server-Sent Events (SSE) response to the client.`
	`4`	`.DESCRIPTION`
	`5`	`This function initiates a Server-Sent Events (SSE) response to the connected client.`
	`6`	`It sets the appropriate headers and keeps the connection open for sending SSEs.`
	`7`	`.EXAMPLE`
	`8`	`Start-KrSseResponse`
	`9`	`Starts an SSE response to the client.`
	`10`	`.NOTES`
	`11`	`This function requires that SSE has been configured on the server using Add-KrSseMiddleware.`
	`12`	`#>`
	`13`	`function Start-KrSseResponse {`
	`14`	`[KestrunRuntimeApi('Route')]`
	`15`	`[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')]`
	`16`	`[CmdletBinding()]`
	`17`	`param()`
	`18`
	`19`	`# Only works inside a route script block where $Context is available`
0	`20`	`if ($null -ne $Context) {`
0	`21`	`$Context.StartSse()`
	`22`	`return`
	`23`	`}`
	`24`
0	`25`	`Write-KrOutsideRouteWarning`
	`26`	`}`