API reference / @chanx-js/nestjs / ChanxModule
Class: ChanxModule
Defined in: packages/nestjs/src/module.ts:19
Serves every @ChanxConsumer provider on the app's HTTP server. Import once, at the root: forRoot(options), or forRootAsync({ useFactory, inject }) for options from other providers.
Extends
ConfigurableModuleClass
Indexable
ts
[key: string]: anyConstructors
Constructor
ts
new ChanxModule(): ChanxModule;Defined in: node_modules/.pnpm/@nestjs+common@12.2.0_class-transformer@0.5.1_class-validator@0.15.1_reflect-metadata@0.2.2_rxjs@7.8.2/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12
Returns
ChanxModule
Inherited from
ts
ConfigurableModuleClass.constructorProperties
forRootAsync
ts
static forRootAsync: (options) => DynamicModule;Parameters
| Parameter | Type |
|---|---|
options | ConfigurableModuleAsyncOptions<ChanxModuleOptions, "create"> & Partial<{ }> |
Returns
DynamicModule
Inherited from
ts
ConfigurableModuleClass.forRootAsyncMethods
forRoot()
ts
static forRoot(options?): DynamicModule;Defined in: packages/nestjs/src/module.ts:20
Parameters
| Parameter | Type |
|---|---|
options | ChanxModuleOptions |
Returns
DynamicModule
Overrides
ts
ConfigurableModuleClass.forRoot