ConfigurableModuleAsyncOptions

Interface that represents the module async options object Factory method name varies depending on the "FactoryClassMethodKey" type argument.


interface ConfigurableModuleAsyncOptions<ModuleOptions, FactoryClassMethodKey extends string = typeof DEFAULT_FACTORY_CLASS_METHOD_KEY> extends Pick {
  useExisting?: Type<ConfigurableModuleOptionsFactory<ModuleOptions, FactoryClassMethodKey>>
  useClass?: Type<ConfigurableModuleOptionsFactory<ModuleOptions, FactoryClassMethodKey>>
  useFactory?: (...args: any[]) => Promise<ModuleOptions> | ModuleOptions
  inject?: FactoryProvider['inject']
  provideInjectionTokensFrom?: Provider[]
}

Child interfaces

Properties

Property Description
useExisting?: Type<ConfigurableModuleOptionsFactory<ModuleOptions, FactoryClassMethodKey>>

Injection token resolving to an existing provider. The provider must implement the corresponding interface.

useClass?: Type<ConfigurableModuleOptionsFactory<ModuleOptions, FactoryClassMethodKey>>

Injection token resolving to a class that will be instantiated as a provider. The class must implement the corresponding interface.

useFactory?: (...args: any[]) => Promise<ModuleOptions> | ModuleOptions

Function returning options (or a Promise resolving to options) to configure the cache module.

inject?: FactoryProvider['inject']

Dependencies that a Factory may inject.

provideInjectionTokensFrom?: Provider[]

List of parent module's providers that will be filtered to only provide necessary providers for the 'inject' array useful to pass options to nested async modules