@scalar/openapi-parser/dist/utils/load/load.d.ts

modern OpenAPI parser written in TypeScript

import type { AnyApiDefinitionFormat, Filesystem, LoadResult, ThrowOnErrorOption } from '../../types/index.js';
export type LoadPlugin = {
    check: (value?: any) => boolean;
    get: (value: any) => any;
    resolvePath?: (value: any, reference: string) => string;
    getDir?: (value: any) => string;
    getFilename?: (value: any) => string;
};
export type LoadOptions = {
    plugins?: LoadPlugin[];
    filename?: string;
    filesystem?: Filesystem;
} & ThrowOnErrorOption;
/**
 * @deprecated This function is deprecated and will be removed in a future version.
 * Please use the new bundler utility instead:
 * ```ts
 * import { bundle } from "@scalar/openapi-parser"
 * ```
 *
 * Loads an OpenAPI document, including any external references.
 *
 * This function handles loading content from various sources, normalizes the content,
 * and recursively loads any external references found within the definition.
 *
 * It builds a filesystem representation of all loaded content and collects any errors
 * encountered during the process.
 */
export declare function load(value: AnyApiDefinitionFormat, options?: LoadOptions): Promise<LoadResult>;
//# sourceMappingURL=load.d.ts.map