@al/deployments
A client for working with the Deployments Alert Logic API.
This library uses @al/core as its HTTP provider interface.
Disclaimer
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
Installation
npm install @al/deployments --save
Usage
var DeploymentsClient = require('@al/deployments').DeploymentsClient; //commonjs - e.g. node
import { DeploymentsClient } from '@al/deployments'; //ES2015 - e.g. Angular, TS projects
Get Deployment
DeploymentsClient.getDeployment(accountId, deploymentId)
accountId: '1234',
deplopymentId: '5678'
Interactive
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
Tests
npm test
Contributing
The sources are written in Typescript and follow the tslint airbnb style.
Building
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.