openapi-typescript/src/transform/headers.ts

Generate TypeScript types from Swagger OpenAPI specs

import { GlobalContext, HeaderObject } from "../types";
import { comment, tsReadonly } from "../utils";
import { transformSchemaObj } from "./schema";

interface TransformHeadersOptions extends GlobalContext {
  required: Set<string>;
}

export function transformHeaderObjMap(
  headerMap: Record<string, HeaderObject>,
  options: TransformHeadersOptions
): string {
  let output = "";

  for (const k of Object.keys(headerMap)) {
    const v = headerMap[k];
    if (!v.schema) continue;

    if (v.description) output += comment(v.description);

    const readonly = tsReadonly(options.immutableTypes);
    const required = v.required ? "" : "?";

    output += `  ${readonly}"${k}"${required}: ${transformSchemaObj(v.schema, options)}\n`;
  }

  return output;
}