ArmorJS - KeyStore
@armorjs/key provides a typesafe, convenient API for accessing dynamic configurations. Eliminates excessive type and safety checks by providing type-safe accessors for key-value pairs.
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/key
With NPM:
npm install @armorjs/key
Usage
Library Usage
Typescript
import { ArmorKey } from '@armorjs/key';
Node
const ArmorKey = require('@armorjs/key');
Build
Build (or rebuild) the config package:
With Yarn (preferred):
yarn install
yarn build
With NPM:
npm install
npm run-script build
Testing
key implements unit tests using jest. Run the following commands from the directory where @armorjs/key has been installed.
With yarn (preferred):
yarn install
yarn test
With NPM:
npm install
npm run-script test
License
MIT © Michael Brich