Write-KrCsvResponse

SYNOPSIS

Writes CSV data to the HTTP response body.

SYNTAX

Write-KrCsvResponse [-InputObject] <Object> [[-StatusCode] <Int32>] [[-ContentType] <String>]
 [[-Delimiter] <Char>] [-IncludeTypeInformation] [[-QuoteFields] <String[]>] [[-UseQuotes] <QuoteKind>]
 [-NoHeader] [<CommonParameters>]

DESCRIPTION

Sends a raw CSV payload to the client and optionally sets the HTTP status code and content type.

EXAMPLES

EXAMPLE 1

Write-KrCsvResponse -InputObject "Name,Age`nAlice,30`nBob,25" -StatusCode 200
Writes the CSV data to the response body with a 200 OK status code.

PARAMETERS

-InputObject

The CSV content to write to the response body. This can be a string or any other object that can be converted to a string.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-StatusCode

The HTTP status code to set for the response. Defaults to 200 (OK).

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 200
Accept pipeline input: False
Accept wildcard characters: False

-ContentType

The content type of the response. If not specified, defaults to “text/csv”.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Delimiter

The character to use as the delimiter in the CSV output. Defaults to a comma (`,`).

Type: Char
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeTypeInformation

Switch to include type information in the CSV output.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-QuoteFields

An array of field names to always quote in the CSV output.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseQuotes

Specifies how to quote fields in the CSV output. Accepts values from the `Microsoft.PowerShell.Commands.BaseCsvWritingCommand+QuoteKind` enum.

Type: QuoteKind
Parameter Sets: (All)
Aliases:
Accepted values: Never, Always, AsNeeded

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoHeader

Switch to omit the header row from the CSV output.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

This function is designed to be used in the context of a Kestrun server response.

RELATED LINKS