@tsed/schema
Version:
JsonSchema module for Ts.ED Framework
59 lines (58 loc) • 1.32 kB
JavaScript
import { isString } from "@tsed/core";
import { Returns } from "./returns.js";
/**
* Sets the response’s HTTP header field to value. To set multiple fields at once, pass an object as the parameter.
*
* ```typescript
* @Header('Content-Type', 'text/plain');
* private myMethod() {}
*
* @Status(204)
* @Header({
* "Content-Type": "text/plain",
* "Content-Length": 123,
* "ETag": {
* "value": "12345",
* "description": "header description"
* }
* })
* private myMethod() {}
* ```
*
* This example will produce the swagger responses object:
*
* ```json
* {
* "responses": {
* "204": {
* "description": "Description",
* "headers": {
* "Content-Type": {
* "type": "string"
* },
* "Content-Length": {
* "type": "number"
* },
* "ETag": {
* "type": "string",
* "description": "header description"
* }
* }
* }
* }
* }
* ```
*
* @decorator
* @operation
* @response
*/
export function Header(headers, value) {
if (value !== undefined) {
headers = { [headers]: value };
}
if (value === undefined && isString(headers)) {
headers = { [headers]: { type: "string" } };
}
return Returns().Headers(headers);
}