Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 2.05 KB

README.md

File metadata and controls

82 lines (59 loc) · 2.05 KB
Raw

awry

Build Status Codecov Known Vulnerabilities

An Asterisk REST Interface websocket and API client library for Node.js.

installation

npm install awry

usage

const awry = require('awry');

const api = new awry.API({
  baseUrl: 'http://asterisk.local:8088/ari',
  username: 'asterisk',
  password: 'asterisk'
});

api.applications.list().then(apps => {
  console.log(apps);
});

const events = awry.Events.connect({
  app: 'someApp',
  url: 'http://asterisk.local:8088/ari/events',
  username: 'asterisk',
  password: 'asterisk'
});

events.on('message', message => {
  console.log(message);
});

documentation

Documentation is available in the repository. You can compile the documentation by doing the following:

git clone git@github.com:chadxz/awry.git
cd awry
npm install
npm run docs

The latest documentation can now be found under the docs directory.

debugging

awry uses the debug module to log debugging output. To enable this output to print to the console, set the environment variable DEBUG to one of the following when running your app:

  • awry:* - shows all debug output from this library.
  • awry:ARIWebSocket - shows only the debug output from the ARIWebSocket sub-module.
  • awry:ReconnectingWebSocket - shows only the debug output from the ReconnectingWebSocket sub-module.

For example: DEBUG=awry:* node myapp.js

contributing

See CONTRIBUTING.md.

license

MIT