projects/core/src/config/config.module.ts
| Static forRoot | ||||||||
forRoot(config: Config)
|
||||||||
|
Defined in projects/core/src/config/config.module.ts:49
|
||||||||
|
Module with providers, should be imported only once, if possible, at the root of the app.
Parameters :
Returns :
ModuleWithProviders<ConfigModule>
|
| Static withConfig | ||||||||
withConfig(config: Config)
|
||||||||
|
Defined in projects/core/src/config/config.module.ts:19
|
||||||||
|
Import ConfigModule and contribute config to the global configuration To provide default configuration in libraries provideDefaultConfig should be used instead.
Parameters :
Returns :
ModuleWithProviders<ConfigModule>
|
| Static withConfigFactory | ||||||||||||
withConfigFactory(configFactory: Function, deps?: any[])
|
||||||||||||
|
Defined in projects/core/src/config/config.module.ts:34
|
||||||||||||
|
Import ConfigModule and contribute config to the global configuration using factory function To provide default configuration in libraries provideDefaultConfigFactory should be used instead.
Parameters :
Returns :
ModuleWithProviders<ConfigModule>
|
import { ModuleWithProviders, NgModule } from '@angular/core';
import { provideConfig, provideConfigFactory } from './config-providers';
import { Config } from './config-tokens';
import { ConfigurationService } from './services/configuration.service';
@NgModule({})
export class ConfigModule {
// To make sure ConfigurationService will be instantiated, we inject it into
// module constructor
constructor(_configurationService: ConfigurationService) {}
/**
* Import ConfigModule and contribute config to the global configuration
*
* To provide default configuration in libraries provideDefaultConfig should be used instead.
*
* @param config Config object to merge with the global configuration
*/
static withConfig(config: Config): ModuleWithProviders<ConfigModule> {
return {
ngModule: ConfigModule,
providers: [provideConfig(config)],
};
}
/**
* Import ConfigModule and contribute config to the global configuration using factory function
*
* To provide default configuration in libraries provideDefaultConfigFactory should be used instead.
*
* @param configFactory Factory function that will generate configuration
* @param deps Optional dependencies to factory function
*/
static withConfigFactory(
configFactory: Function,
deps?: any[]
): ModuleWithProviders<ConfigModule> {
return {
ngModule: ConfigModule,
providers: [provideConfigFactory(configFactory, deps)],
};
}
/**
* Module with providers, should be imported only once, if possible, at the root of the app.
*
* @param config
*/
static forRoot(config: Config = {}): ModuleWithProviders<ConfigModule> {
return {
ngModule: ConfigModule,
providers: [provideConfig(config)],
};
}
}