UNPKG

@rxap/nest-open-api

Version:

This package provides tools and utilities for integrating OpenAPI specifications into NestJS applications. It includes features for handling upstream API requests, managing server configurations, and generating OpenAPI documentation. It also offers interc

22 lines (21 loc) 1.4 kB
import { DynamicModule } from '@nestjs/common'; import { Constructor } from '@rxap/utilities'; import { OpenApiServerConfig, OpenApiUpstreamInterceptor } from './open-api-operation/types'; export interface OpenApiModuleOptions { serverConfig?: OpenApiServerConfig[]; interceptors?: OpenApiUpstreamInterceptor[]; } export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<OpenApiModuleOptions, "register", "create", { isGlobal: boolean; }>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: OpenApiModuleOptions & Partial<{ isGlobal: boolean; }>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<OpenApiModuleOptions, "create"> & Partial<{ isGlobal: boolean; }>; export declare class OpenApiModule extends ConfigurableModuleClass { static register(options: typeof OPTIONS_TYPE, interceptors?: Constructor<OpenApiUpstreamInterceptor>[]): DynamicModule; static registerAsync(options: typeof ASYNC_OPTIONS_TYPE, interceptors?: Constructor<OpenApiUpstreamInterceptor>[]): DynamicModule; private static updateProviders; } export declare function OpenApiServerConfigFactory(options: OpenApiModuleOptions): OpenApiServerConfig[]; export declare function OpenApiUpstreamInterceptorFactory(options: OpenApiModuleOptions, ...additionalInterceptors: OpenApiUpstreamInterceptor[]): OpenApiUpstreamInterceptor[];