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

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

import type { Hono, MiddlewareHandler } from "hono";
import type { ControllerConstructor } from "@hestjs/core";
import type { ScalarConfig, ScalarMiddlewareConfig } from "./scalar-config.interface";
import { type OpenAPIGeneratorConfig } from './openapi-generator';
/**
 * 创建 Scalar 中间件
 */
export declare function createScalarMiddleware(config: ScalarMiddlewareConfig): MiddlewareHandler;
/**
 * 创建 Markdown 中间件（供 LLM 使用）
 */
export declare function createMarkdownMiddleware(spec: string | object): MiddlewareHandler;
/**
 * 在 Hono 应用上设置 Scalar
 */
export declare function setupScalar(app: Hono, config: ScalarConfig): void;
/**
 * 从控制器生成 OpenAPI 并设置 Scalar
 */
export declare function setupScalarWithControllers(app: Hono, controllers: ControllerConstructor[], generatorConfig: OpenAPIGeneratorConfig, scalarConfig?: Omit<ScalarConfig, 'spec'>): void;
//# sourceMappingURL=scalar.middleware.d.ts.map