Write-KrBsonResponse

SYNOPSIS

Writes an object serialized as BSON to the HTTP response.

SYNTAX

Write-KrBsonResponse [-InputObject] <Object> [[-StatusCode] <Int32>] [[-ContentType] <String>]
 [<CommonParameters>]

DESCRIPTION

Converts the provided object to BSON format and writes it to the response body. The status code and content type can be customized.

EXAMPLES

EXAMPLE 1

Write-KrBsonResponse -InputObject $myObject -StatusCode 200 -ContentType "application/bson"
Writes the $myObject serialized as BSON to the response with a 200 status code and content type "application/bson".

PARAMETERS

-InputObject

The object to serialize and write to the response.

Type: Object
Parameter Sets: (All)
Aliases:

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

-StatusCode

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

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 to set for the response. If not specified, defaults to application/bson.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
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