koas-parameters/lib/utils.d.ts

Koas parameters attempts to coerce path and query parameters to the type specified in their respective JSON schema.

import { Context } from 'koa';
import { JSONRefResolver, Validator } from 'koas-core';
import { OpenAPIV3 } from 'openapi-types';
import { ParameterParsers } from '.';
/**
 * Create a function for parsing and validating query and path parameters.
 *
 * @param operationObject - The active OpenAPI operation object.
 * @param parameters - The active OpenAPI parameters object.
 * @param parsers - Provided parameter parser functions.
 * @param validate - The schema validator function.
 * @param resolveRef - A JSON reference resolver.
 * @returns A function for parsing and validating query and path parameters.
 */
export declare function createParameterHandler(operationObject: OpenAPIV3.OperationObject, parameters: (OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject)[], parsers: ParameterParsers, validate: Validator, resolveRef: JSONRefResolver): (ctx: Context) => void;