ArmorJS - Action Result
@armorjs/action-result provides a simple, consistent interface to parse action results when you need more than
Contents
- [Examples]
- About ArmorJS
- Installation
- Usage
- Build
- Testing
- License
Examples
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/action-result
With NPM:
npm install @armorjs/action-result
Usage
Library Usage
Typescript
import { ArmorActionResult } from '@armorjs/action-result';
Node
const ArmorConfig = require('@armorjs/action-result');
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