You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

freepbx

Package Overview
Dependencies
Maintainers
2
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

freepbx

The FreePBX connector for NodeJS modules. Allows NodeJS modules to access common functions in FreePBX systems. Also simulates the FreePBX boostrap


Version published
Maintainers
2
Created

Readme

Source

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

FAQs

Package last updated on 13 Aug 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc