@hestjs/scalar/dist/extensions.d.ts

HestJS Scalar API Reference Integration - Beautiful API documentation for HestJS applications

import type { ControllerConstructor } from "@hestjs/core";
import type { ScalarConfig } from "./scalar-config.interface";
import type { OpenAPIGeneratorConfig } from './openapi-generator';
/**
 * 扩展 HestApplicationInstance 以支持 Scalar
 */
declare module "@hestjs/core" {
    interface HestApplicationInstance {
        /**
         * 配置 Scalar API 文档
         */
        useScalar(config: ScalarConfig): void;
        /**
         * 弃用，使用 useScalarAutoDiscover 方法
         * 从控制器自动生成 OpenAPI 并配置 Scalar(手动传入控制器)
         */
        /**
         * 从控制器自动生成 OpenAPI 并配置 Scalar
         */
        useSwagger(generatorConfig: OpenAPIGeneratorConfig, scalarConfig?: Omit<ScalarConfig, 'spec'>): void;
        /**
         * 自动发现控制器的辅助方法
         */
        autoDiscoverControllers(): ControllerConstructor[];
    }
}
/**
 * 为 HestApplicationInstance 添加 Scalar 方法
 */
export declare function extendWithScalar(): void;
//# sourceMappingURL=extensions.d.ts.map