@fullerstack/ngx-cfg
v0.0.8
Published
A Configuration Utility Library for Angular
Downloads
19
Maintainers
Readme
@fullerstack/ngx-cfg
An Angular Configuration Library - Handles local and remote configurations
Overview
Description
In general, passing the environment.ts
into your publishable libraries may not be possible unless a relative path is used. However, relative paths will break the dependency graph of your mono-repo stack. This is due to the fact that the libs should not have any knowledge of the applications using them. If so, that will constitute a circular dependency.
Till Angular
natively supports something like, import { environment } from '@angular/core/environment'
, your publishable libs must implement an InjectionToken
to receive the environment
object and provide it with an APP_INITIALIZER
directly during the app's bootstrapping.
Alternatively, you can have a simple lib such as @fullerstack/ngx-cfg
to receive the environment
object and provide it to all other publishable libs via an injectable service such as CfgService
.
@fullerstack/ngx-cfg attempts to streamline the sharing of the content of the environment.ts
while promoting DRY DRY.
How to install
npm i @fullerstack/ngx-cfg |OR| yarn add @fullerstack/ngx-cfg
How to use
// In your environment{prod,staging}.ts
import { ApplicationCfg, HttpMethod } from '@fullerstack/ngx-cfg';
export const environment: Readonly<ApplicationCfg> = {
// production, staging or development
production: false,
// one or more app specific field(s)
version: '1.0.0',
};
// In your app.module.ts
import { CfgModule } from '@fullerstack/ngx-cfg';
import { environment } from '../environments/environment';
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule, CfgModule.forRoot(environment)],
bootstrap: [AppComponent],
})
export class AppModule {}
// In your app.component.ts or (some.service.ts)
import { Component } from '@angular/core';
import { CfgService } from '@fullerstack/ngx-cfg';
@Component({
selector: 'app-root',
})
export class AppComponent {
title: string;
constructor(public cfgService: CfgService) {
this.title = this.cfgService.options.appName;
}
}
Advanced usage:
- Remote configuration
@fullerstack/ngx-cfg
can also be used to fetch remote configuration prior to start of an Angular app.
// In your environment{prod,staging}.ts
import { ApplicationCfg, HttpMethod } from '@fullerstack/ngx-cfg';
export const environment: ApplicationCfg = {
// production, staging or development
production: true,
// release version
version: '1.0.0',
// remote configuration (from the server prior to ng bootstrap)
remoteCfg: {
// server url to get remote config from (default = null)
endpoint: '/api/cfg',
// GET or POST http method to connect to remote server (default = get)
method: HttpMethod.GET,
// Max timeout of http connection to remote server (default = 2 seconds)
timeout: 3,
// http headers to include in http connection to remote server
headers: { 'Content-Type': 'application/json' }
// body of request when using http POST method (default = {})
body: {
// one or more app specific field(s)
}
}
// one or more app specific field(s)
};
// In your app.module.ts
import { CfgModule } from '@fullerstack/ngx-cfg';
import { environment } from '../environments/environment';
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule, CfgModule.forRoot(environment)],
bootstrap: [AppComponent],
})
export class AppModule {}
// In your app.component.ts or (some.service.ts)
import { Component } from '@angular/core';
import { CfgService } from '@fullerstack/ngx-cfg';
import { merge } from 'lodash';
@Component({
selector: 'app-root'
})
export class AppComponent {
title: string;
options = {};
constructor(public cfgService: CfgService) {
this.options = merge({ name: 'AppComponent' }, this.cfgService.options};
const remoteCfgData = this.options.remoteData;
}
}
License
Released under a (MIT) license.
Version
X.Y.Z Version
`MAJOR` version -- making incompatible API changes
`MINOR` version -- adding functionality in a backwards-compatible manner
`PATCH` version -- making backwards-compatible bug fixes