Add a `forRootAsync` method to dynamically configure module settings (e.g. using the ConfigService)

[daanhegger]

Is there an existing issue that is already proposing this?

• I have searched the existing issues

Is your feature request related to a problem? Please describe it

When configuring the ScheduleModule settings, like the cronJobs param, I would like to use a value of my ConfigService. With the current forRoot method, it is not possible to access an instance of the ConfigService.

Describe the solution you'd like

Other (native) NestJS modules provide a method forRootAsync, which allows importing and injecting the ConfigService to consume its values for setting up the module.

Teachability, documentation, adoption, migration strategy

Example usage:

ScheduleModule.forRootAsync({
  imports: [ConfigModule],
  inject: [ConfigService],
  useFactory: (configService: ConfigService<AppConfig>) => ({
    cronJobs: configService.get('ENABLE_CRON_JOBS', { infer: true }),
  }),
}),

What is the motivation / use case for changing the behavior?

Implementing/fixing this

• Allows for a cleaner module setup using a single source of truth.
• Aligns the API with many other NestJS modules.

[kamilmysliwiec]

https://docs.nestjs.com/techniques/configuration#conditional-module-configuration ?

[daanhegger]

https://docs.nestjs.com/techniques/configuration#conditional-module-configuration ?

This only allows for conditional module enabling using environment variables. The variables loaded from the ConfigService could come from other sources too (e.g. network, YAML files, etc).

Also this solution only allows for enabling/disabling the complete ScheduleModule. What if I only want to conditionally disable the cron-feature, and not the timeout-feature?

[kamilmysliwiec]

Would you like to create a PR for this issue?