OpenAPIBaseModule

@tsed/openapi-utils

Usage

import { OpenAPIBaseModule } from "@tsed/openapi-utils";

See /packages/specs/openapi-utils/src/services/OpenAPIBaseModule.ts.

Overview

abstract class OpenAPIBaseModule implements OnRoutesInit, OnReady {
    abstract name: string;
    abstract rootDir: string;
    abstract settings: OpenApiSettings[];
    protected openAPIService: OpenAPIService;
    protected env: Env | undefined;
    protected disableRoutesSummary: boolean | undefined;
    $onRoutesInit(): void;
    $onReady(): void;
    generateSpecFiles(): Promise<void[]>;
    protected createRouter(conf: OpenApiSettings): PlatformRouter;
}

abstract name

abstract name: string;

abstract rootDir

abstract rootDir: string;

abstract settings

abstract settings: OpenApiSettings[];

protected openAPIService

protected openAPIService: OpenAPIService;

protected env

protected env: Env | undefined;

protected disableRoutesSummary

protected disableRoutesSummary: boolean | undefined;

$onRoutesInit

$onRoutesInit(): void;

$onReady

$onReady(): void;

generateSpecFiles

generateSpecFiles(): Promise<void[]>;

protected createRouter

protected createRouter(conf: OpenApiSettings): PlatformRouter;