Need private packages and team management tools?Check out npm Teams »

freepbx

3.0.0 • Public • Published

FreePBX Node JS Module

This module is used to connect a Node Process to the FreePBX ecosystem. It basic mysql and asterisk manager connections that you can interact with as well

npm install freepbx --save

Usage

You can utilize FreePBX like so:

var FreePBX = require("freepbx");
 
FreePBX.connect().then(function (pbx) {
    //FreePBX is now ready
    //pbx.ami == https://github.com/pipobscure/NodeJS-AsteriskManager
    //pbx.db == https://github.com/mysqljs/mysql
    //pbx.kvstore == FreePBX kvstore
    //pbx.config == FreePBX Config
 
    //Note these two are promised based libraries!!
    //freepbx.config == see example below:
 
    pbx.config.get("VALUE FROM ADVANCED SETTINGS")
    .then(function(val) {
        console.log(val);
    }).catch(function(err) {
    });;
 
    //freepbx.kvstore == see examples below:
 
    console.log("PBX is ready");
    pbx.kvstore.setConfig('Dashboard','foo',"hello world")
    .then(function(res) {
        return pbx.kvstore.getConfig('Dashboard','foo')
    })
    .then(function(val) {
        console.log(val)
    }).catch(function(err) {
        console.log(err);
    });
});

Building

All development should be done in the src/ directory. When finished editing/testing then execute the grunt file as so:

grunt

This will update the files in dist/ for distribution to npmjs.org

The repository is at: https://git.freepbx.org/projects/FL/repos/freepbx-nodejs/browse

Keywords

none

Install

npm i freepbx

DownloadsWeekly Downloads

1,022

Version

3.0.0

License

AGPL-3.0

Unpacked Size

133 kB

Total Files

20

Last publish

Collaborators

  • avatar
  • avatar