seng-config

Config

Config Description

Installation

npm i -S seng-config

Usage

import ConfigManager from 'seng-config';
import {IConfig, IURLData} from 'seng-config';
import IConfig from 'seng-config/dist/lib/IConfig';

var configManager = new ConfigManager();

// init the manager with provided config
configManager.init(config, 'production');

// get a url
configManager.getURL('api');

// get a property
configManager.getProperty('defaultLocale');

Documentation

View the generated documentation.

Building

In order to build seng-config, ensure that you have Git and Node.js installed.

Clone a copy of the repo:

git clone https://github.com/MediaMonks/seng-config.git

Change to the seng-config directory:

cd seng-config

Install dev dependencies:

npm install

Use one of the following scripts:

npm run build   	# build this project (done on install)
npm test    		# run the tests
npm run lint		# run tslint on this project
npm run doc			# generate typedoc documentation

Contribute

View CONTRIBUTING.md

Changelog

View CHANGELOG.md

Authors

View AUTHORS.md

LICENSE

MIT © MediaMonks