Class: SwaggerUiModule
Extends
- SwaggerUiModuleClass
Constructors
new SwaggerUiModule()
new SwaggerUiModule():
SwaggerUiModule
Returns
Inherited from
SwaggerUiModuleClass.constructor
Defined in
node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12
Methods
forRoot()
staticforRoot(options):DynamicModule
Parameters
| Parameter | Type | 
|---|---|
| options | SwaggerUiOptions | 
Returns
DynamicModule
Defined in
packages/nestjs-swagger-ui/src/swagger-ui.module.ts:18 (opens in a new tab)
forRootAsync()
staticforRootAsync(options):DynamicModule
Parameters
| Parameter | Type | 
|---|---|
| options | SwaggerUiAsyncOptions | 
Returns
DynamicModule
Defined in
packages/nestjs-swagger-ui/src/swagger-ui.module.ts:22 (opens in a new tab)
register()
staticregister(options):DynamicModule
Parameters
| Parameter | Type | 
|---|---|
| options | SwaggerUiOptions | 
Returns
DynamicModule
Overrides
SwaggerUiModuleClass.register
Defined in
packages/nestjs-swagger-ui/src/swagger-ui.module.ts:10 (opens in a new tab)
registerAsync()
staticregisterAsync(options):DynamicModule
Parameters
| Parameter | Type | 
|---|---|
| options | SwaggerUiAsyncOptions | 
Returns
DynamicModule
Overrides
SwaggerUiModuleClass.registerAsync
Defined in
packages/nestjs-swagger-ui/src/swagger-ui.module.ts:14 (opens in a new tab)