MongooseModule

  
class MongooseModule {
  static forRoot(uri: string, options: MongooseModuleOptions = {}): DynamicModule
  static forRootAsync(options: MongooseModuleAsyncOptions): DynamicModule
  static forFeature(models: ModelDefinition[] = [], connectionName?: string): DynamicModule
  static forFeatureAsync(factories: AsyncModelFactory[] = [], connectionName?: string): DynamicModule
}

Static methods

forRoot()


static forRoot(uri: string, options: MongooseModuleOptions = {}): DynamicModule

Parameters

Option Type Description
uri string
options MongooseModuleOptions

Optional. Default is {}.

Returns

DynamicModule

forRootAsync()


static forRootAsync(options: MongooseModuleAsyncOptions): DynamicModule

Parameters

Option Type Description
options MongooseModuleAsyncOptions

Returns

DynamicModule

forFeature()


static forFeature(models: ModelDefinition[] = [], connectionName?: string): DynamicModule

Parameters

Option Type Description
models ModelDefinition[]

Optional. Default is [].

connectionName string

Optional. Default is undefined.

Returns

DynamicModule

forFeatureAsync()


static forFeatureAsync(factories: AsyncModelFactory[] = [], connectionName?: string): DynamicModule

Parameters

Option Type Description
factories AsyncModelFactory[]

Optional. Default is [].

connectionName string

Optional. Default is undefined.

Returns

DynamicModule