API Reference
Rockets Core API
nestjs-swagger-ui
classes
SwaggerUiModule

Class: SwaggerUiModule

Extends

  • SwaggerUiModuleClass

Constructors

new SwaggerUiModule()

new SwaggerUiModule(): SwaggerUiModule

Returns

SwaggerUiModule

Inherited from

SwaggerUiModuleClass.constructor

Defined in

node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Methods

forRoot()

static forRoot(options): DynamicModule

Parameters

ParameterType
optionsSwaggerUiOptions

Returns

DynamicModule

Defined in

packages/nestjs-swagger-ui/src/swagger-ui.module.ts:18 (opens in a new tab)


forRootAsync()

static forRootAsync(options): DynamicModule

Parameters

ParameterType
optionsSwaggerUiAsyncOptions

Returns

DynamicModule

Defined in

packages/nestjs-swagger-ui/src/swagger-ui.module.ts:22 (opens in a new tab)


register()

static register(options): DynamicModule

Parameters

ParameterType
optionsSwaggerUiOptions

Returns

DynamicModule

Overrides

SwaggerUiModuleClass.register

Defined in

packages/nestjs-swagger-ui/src/swagger-ui.module.ts:10 (opens in a new tab)


registerAsync()

static registerAsync(options): DynamicModule

Parameters

ParameterType
optionsSwaggerUiAsyncOptions

Returns

DynamicModule

Overrides

SwaggerUiModuleClass.registerAsync

Defined in

packages/nestjs-swagger-ui/src/swagger-ui.module.ts:14 (opens in a new tab)