< Summary - Kestrun — Combined Coverage

Information
Class: Public.Response.Write-KrYamlResponse
Assembly: Kestrun.PowerShell.Public
File(s): /home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/Response/Write-KrYamlResponse.ps1
Tag: Kestrun/Kestrun@9d3a582b2d63930269564a7591aa77ef297cadeb
Line coverage
0%
Covered lines: 0
Uncovered lines: 2
Coverable lines: 2
Total lines: 38
Line coverage: 0%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

File(s)

/home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/Response/Write-KrYamlResponse.ps1

#LineLine coverage
 1<#
 2    .SYNOPSIS
 3        Writes an object to the HTTP response body as YAML.
 4
 5    .DESCRIPTION
 6        Serializes the provided object to YAML using the underlying C# helper and
 7        sets the specified status code on the response.
 8    .PARAMETER InputObject
 9        The object to serialize and write to the response body. This can be any
 10        PowerShell object, including complex types.
 11    .PARAMETER StatusCode
 12        The HTTP status code to set for the response. Defaults to 200 (OK).
 13    .PARAMETER ContentType
 14        The content type of the response. If not specified, defaults to "application/yaml".
 15    .EXAMPLE
 16        Write-KrYamlResponse -InputObject $myObject -StatusCode 200 -ContentType "application/x-yaml"
 17        Writes the $myObject serialized as YAML to the response with a 200 status code
 18        and content type "application/x-yaml".
 19    .NOTES
 20        This function is designed to be used in the context of a Kestrun server response.
 21#>
 22function Write-KrYamlResponse {
 23    [KestrunRuntimeApi('Route')]
 24    [CmdletBinding()]
 25    param(
 26        [Parameter(Mandatory = $true)]
 27        [object]$InputObject,
 28        [Parameter()]
 29        [int]$StatusCode = 200,
 30        [Parameter()]
 31        [string]$ContentType
 32    )
 033    if ($null -ne $Context.Response) {
 34        # Call the C# method on the $Context.Response object
 035        $Context.Response.WriteYamlResponse($InputObject, $StatusCode, $ContentType)
 36    }
 37}
 38

Methods/Properties

Write-KrYamlResponse()