ArmorJS - Config
@armorjs/config provides a typesafe, convenient API for accessing dynamic configurations. Eliminates excessive type and safety checks by providing accessors for all configuration keys with guaranteed type returns.
Contents
About ArmorJS
ArmorJS solves unique challenges in the enterprise node ecosystem. Auditing projects for security, reliability, and even license compatibility are monumental tasks when a project includes thousands of frequently changing dependencies.
ArmorJS standards:
- Full typescript support.
- Consistent API between releases.
- Extremely small footprint (for webpacking).
- No more than 5 external dependencies (excluding dev dependencies).
- Compatible with web, node, and serverless deployment.
- Thorough test coverage.
- MIT License.
Install
With yarn (preferred):
yarn add @armorjs/config
With NPM:
npm install @armorjs/config
Usage
Library Usage
Typescript
import { ArmorConfig } from '@armorjs/config';
Node
const ArmorConfig = require('@armorjs/config');
Build
Build (or rebuild) the config package:
With Yarn (preferred):
yarn install
yarn build
With NPM:
npm install
npm run-script build
Testing
Config implements unit tests using jest. Run the following commands from the directory where config has been installed.
With yarn (preferred):
yarn install
yarn test
With NPM:
npm install
npm run-script test
License
MIT © Michael Brich
