util.d.ts 1.1 KB

12345678910111213141516171819202122232425262728293031
  1. export namespace util {
  2. /**
  3. * Retrieves a header name and returns its lowercase value.
  4. * @param value Header name
  5. */
  6. export function headerNameToString(value: string | Buffer): string;
  7. /**
  8. * Receives a header object and returns the parsed value.
  9. * @param headers Header object
  10. */
  11. export function parseHeaders(
  12. headers:
  13. | Record<string, string | string[]>
  14. | (Buffer | string | (Buffer | string)[])[]
  15. ): Record<string, string | string[]>;
  16. /**
  17. * Receives a header object and returns the parsed value.
  18. * @param headers Header object
  19. * @param obj Object to specify a proxy object. Used to assign parsed values. But, if `headers` is an object, it is not used.
  20. * @returns If `headers` is an object, it is `headers`. Otherwise, if `obj` is specified, it is equivalent to `obj`.
  21. */
  22. export function parseHeaders<
  23. H extends
  24. | Record<string, string | string[]>
  25. | (Buffer | string | (Buffer | string)[])[]
  26. >(
  27. headers: H,
  28. obj?: H extends any[] ? Record<string, string | string[]> : never
  29. ): Record<string, string | string[]>;
  30. }