@tsed/schema
Version:
JsonSchema module for Ts.ED Framework
48 lines (47 loc) • 1.43 kB
JavaScript
/**
* HTTP operation parameter location types.
*
* This enum defines where parameters can be located in an HTTP request.
* These types are used for both JSON Schema and OpenAPI parameter definitions.
*
* ### Parameter Locations
*
* - **BODY**: Request body parameter (payload)
* - **PATH**: URL path parameter (e.g., `/users/{id}`)
* - **QUERY**: URL query string parameter (e.g., `?page=1`)
* - **HEADER**: HTTP header parameter (e.g., `Authorization`)
* - **COOKIES**: Cookie parameter
* - **FILES**: File upload parameter (multipart/form-data)
*
* ### Usage
*
* ```typescript
* import {JsonParameterTypes} from "@tsed/schema";
*
* parameter.in(JsonParameterTypes.QUERY);
* parameter.in(JsonParameterTypes.PATH);
* ```
*
* @public
*/
export var JsonParameterTypes;
(function (JsonParameterTypes) {
JsonParameterTypes["BODY"] = "body";
JsonParameterTypes["PATH"] = "path";
JsonParameterTypes["QUERY"] = "query";
JsonParameterTypes["HEADER"] = "header";
JsonParameterTypes["COOKIES"] = "cookie";
JsonParameterTypes["FILES"] = "files";
})(JsonParameterTypes || (JsonParameterTypes = {}));
/**
* @ignore
*/
export function formatParameterType(type) {
return String(type).toLowerCase().replace("raw_", "").replace("cookies", "cookie");
}
/**
* @ignore
*/
export function isParameterType(type) {
return Object.values(JsonParameterTypes).includes(formatParameterType(type));
}