body-parser.d.ts 919 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. import {IncomingMessage} from 'http';
  2. import {Service} from '../service.js';
  3. import {ValueOrPromise} from '../types.js';
  4. /**
  5. * Method names to be parsed.
  6. */
  7. export type METHODS_WITH_BODY = string[];
  8. /**
  9. * Unparsable media types.
  10. */
  11. export type UNPARSABLE_MEDIA_TYPES = string[];
  12. /**
  13. * Body parser function.
  14. */
  15. export type BodyParserFunction = <T = unknown>(input: string) => T;
  16. /**
  17. * Body parser.
  18. */
  19. export declare class BodyParser extends Service {
  20. /**
  21. * Define parser.
  22. *
  23. * @param mediaType
  24. * @param parser
  25. */
  26. defineParser(mediaType: string, parser: BodyParserFunction): this;
  27. /**
  28. * Has parser.
  29. *
  30. * @param mediaType
  31. */
  32. hasParser(mediaType: string): boolean;
  33. /**
  34. * Delete parser.
  35. *
  36. * @param mediaType
  37. */
  38. deleteParser(mediaType: string): this;
  39. /**
  40. * Parse.
  41. *
  42. * @param req
  43. */
  44. parse<T = unknown>(req: IncomingMessage): ValueOrPromise<T>;
  45. }