Skip to content

README.md

Latest commit

 

History

History
46 lines (31 loc) · 1.17 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.17 KB

node-iris

This is a library for communicating with the Iris API.

Usage

npm install iris-client

Use:

This will work with the pre-seeded data, created by following the instructions

const  ic =require('./app.js');

const config = {
  app   :  "test-app",
  key   :  "sdffdssdf",
  url  :  "http://127.0.0.1:16649/"
}

const IrisClient = new ic(config);
try{
  // Create an incident
  IrisClient.incident('demo-test-foo', {foo:"bar"});

  // create a notification
  IrisClient.notify(
      'demo-test-foo'
    );
}catch(err){
  //do something with error
  console.log(err)
}

Notes

The url specified needs to hit the iris API not the iris relay. The relay can only respond to and handle existing incedents. The relay cannot create new incidents.

Contributing

License is MIT. I really don't care how the PR's come as long as I can read what the change is and you include a reason why

This project is dedicated to amazing success and talent of a #nastyWoman #womenInSTEM