@loopback/rest/src/body-parsers/types.ts

Expose controllers as REST endpoints and route REST API requests to controller methods

// Copyright IBM Corp. and LoopBack contributors 2018,2019. All Rights Reserved.
// Node module: @loopback/rest
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT

import {ReferenceObject, SchemaObject} from '@loopback/openapi-v3';
import {Request} from '../types';
/**
 * Request body with metadata
 */
export type RequestBody = {
  /**
   * Parsed value of the request body
   */
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  value: any | undefined;
  /**
   * Is coercion required? Some forms of request such as urlencoded don't
   * have rich types such as number or boolean.
   */
  coercionRequired?: boolean;
  /**
   * Resolved media type
   */
  mediaType?: string;
  /**
   * Corresponding schema for the request body
   */
  schema?: SchemaObject | ReferenceObject;
};

/**
 * Interface to be implemented by body parser extensions
 */
export interface BodyParser {
  /**
   * Name of the parser
   */
  name: string | symbol;
  /**
   * Indicate if the given media type is supported
   * @param mediaType - Media type
   */
  supports(mediaType: string): boolean;
  /**
   * Parse the request body
   * @param request - http request
   */
  parse(request: Request): Promise<RequestBody>;
}

/**
 * Plain function for body parsing
 */
export type BodyParserFunction = (request: Request) => Promise<RequestBody>;

/**
 * Binding tag for request body parser extensions
 */
export const REQUEST_BODY_PARSER_TAG = 'rest.requestBodyParser';