koas-core/lib/jsonRefs.d.ts

> [Koa][] + [OpenAPI Specification][] = Koas

import { OpenAPIV3 } from 'openapi-types';
/**
 * A function to resolve a JSON reference in a given document.
 *
 * @param ref - The JSON reference object to resolve
 * @returns The resolved value.
 */
export declare type JSONRefResolver = <T>(ref: OpenAPIV3.ReferenceObject | T) => T;
/**
 * Escape a JSON pointer segment.
 *
 * See https://tools.ietf.org/html/rfc6901#section-3
 *
 * @param pointer - THe JSON pointer segment to escape.
 * @returns The escaped JSON pointer segment.
 */
export declare function escapeJsonPointer(pointer: string): string;
/**
 * Unescape a JSON pointer segment.
 *
 * See https://tools.ietf.org/html/rfc6901#section-3
 *
 * @param pointer - The JSON pointer segment to unescape
 * @returns The unescaped JSON pointer segment.
 */
export declare function unescapeJsonPointer(pointer: string): string;
/**
 * Create a function to resolve a JSON pointer from an OpenAPI document with caching.
 *
 * @param document - The OpenAPI document to create a resolver for.
 * @returns A JSON ref resolver.
 */
export declare function createResolver(document: OpenAPIV3.Document): JSONRefResolver;