A lightweight client library for interacting with the Herald API
npm install @al/herald @al/herald
=========
A lightweight client library for interacting with the Herald API.
This library uses @al/herald as its HTTP provider interface.
Until the release of version 1.0.0 all current minor version increments may be backwards incompatible. Please bear this in mind when developing against this library. Should you have any further questions, please do not hesitate to contact us as npm@alertlogic.com
npm install @al/herald --save
var HeraldClient = require('@al/herald').HeraldClient; //commonjs - e.g. node
import { HeraldClient } from '@al/herald'; //ES2015 - e.g. Angular, TS projects
Loads the library into memory and stays in an interactive node shell.
npm run interactive
NOTE - You must build the sources before running this command, see Building section below
npm test
The sources are written in Typescript and follow the tslint airbnb style.
To generate a production build
npm run build
To generate a development build
npm run build-dev
Builds will be be generated into a dist folder and will contain commonjs and umd bundles that will be consumed depending on the module system in whichever environment you are using.