Git Product home page Git Product logo

awry's Introduction

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 [email protected]: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

awry's People

Contributors

chadxz avatar greenkeeper[bot] avatar greenkeeperio-bot avatar octoquad avatar

Stargazers

Kumawat Lalit avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.