I would like to create a REST API with NestJs and TypeORM. In my app.module.ts I load the TypeORM module
@Module({
imports: [
TypeOrmModule.forRoot({
type: 'postgres',
host: 'localhost',
port: 5432,
username: 'postgres',
password: 'postgres',
database: 'api',
entities: [`${__dirname}/**/*.entity.{ts,js}`],
synchronize: true,
}),
],
})
export class AppModule {}
and it's working fine for now. I would like to load the configuration from an external .env file so from the docs
https://docs.nestjs.com/techniques/database#async-configuration
and from here
NestJS Using ConfigService with TypeOrmModule
I created a .env file in the root project directory with the following content
DATABASE_TYPE = postgres
DATABASE_HOST = localhost
DATABASE_PORT = 5432
DATABASE_USERNAME = postgres
DATABASE_PASSWORD = postgres
DATABASE_NAME = api
DATABASE_SYNCHRONIZE = true
Next I update my code to
@Module({
imports: [
ConfigModule.forRoot(),
TypeOrmModule.forRootAsync({
imports: [ConfigModule],
useFactory: async (configService: ConfigService) => ({
type: configService.get<any>('DATABASE_TYPE'),
host: configService.get<string>('DATABASE_HOST'),
port: configService.get<number>('DATABASE_PORT'),
username: configService.get<string>('DATABASE_USERNAME'),
password: configService.get<string>('DATABASE_PASSWORD'),
database: configService.get<string>('DATABASE_NAME'),
entities: [`${__dirname}/**/*.entity.{ts,js}`],
synchronize: configService.get<boolean>('DATABASE_SYNCHRONIZE'),
}),
inject: [ConfigService],
}),
],
})
export class AppModule {}
Unfortunately I get this error on startup
[Nest] 28257 - 01/06/2020, 7:19:20 AM [ExceptionHandler] Nest can't resolve dependencies of the TypeOrmModuleOptions (?). Please make sure that the argument ConfigService at index [0] is available in the TypeOrmCoreModule context.
Potential solutions:
- If ConfigService is a provider, is it part of the current TypeOrmCoreModule?
- If ConfigService is exported from a separate @Module, is that module imported within TypeOrmCoreModule?
@Module({
imports: [ /* the Module containing ConfigService */ ]
})
+1ms
When I log the configuration in my main.ts within the bootstrap function I get a correct configuration from the .env file.
How can I fix the error?
One of two things needs to happen:
1) You need to make your ConfigModule
global by passing the isGlobal: true
option to ConfigModule.forRoot()
. If you do this, then you can remove the import in the TypeormModule.forRootAsync()
(it's then a global module and can have it's providers used anywhere)
2) Make another module (MyConfigModule
or something) that imports
the ConfigModule
with its configuration and exports
the CofnigModule
. Then you can change ConfigModule.forRoot()
to MyConfigModule
in the AppModule
and you can change imports: [ConfigModule]
to imports: [MyConfigModule]
in the TypeormModule.forRootAsync()
configuration.