Skip to content

SwaggerModule

@tsed/swagger

Usage

typescript
import { SwaggerModule } from "@tsed/swagger";

See /packages/specs/swagger/src/types/SwaggerModule.ts.

Overview

ts
class SwaggerModule implements OnRoutesInit, OnReady {
    protected swaggerService: SwaggerService;
    protected env: Env | undefined;
    protected disableRoutesSummary: boolean | undefined;
    get settings(): SwaggerSettings[];
    $onRoutesInit(): void;
    $onReady(): void;
    generateSpecFiles(): Promise<void[]>;
    
    
}

protected swaggerService

ts
protected swaggerService: SwaggerService;

protected env

ts
protected env: Env | undefined;

protected disableRoutesSummary

ts
protected disableRoutesSummary: boolean | undefined;

get settings

ts
get settings(): SwaggerSettings[];

$onRoutesInit

ts
$onRoutesInit(): void;

$onReady

ts
$onReady(): void;

generateSpecFiles

ts
generateSpecFiles(): Promise<void[]>;

Released under the MIT License.