tree: 229062c66c1a01695cccfeba2883160ec88fa318 [path history] [tgz]
  1. examples/
  2. node_modules/
  3. test/
  4. .npmignore
  5. gulpfile.js
  6. index.js
  7. LICENSE
  8. package.json
  9. README.md
node_modules/node-firefox-connect/README.md

node-firefox-connect Build Status

Connects to a Firefox debuggable runtime.

Install with NPM

This is part of the node-firefox project.

Installation

From git

git clone https://github.com/mozilla/node-firefox-connect.git
cd node-firefox-connect
npm install

If you want to update later on:

cd node-firefox-connect
git pull origin master
npm install

npm

npm install node-firefox-connect

Usage

Connects to a Firefox runtime, given a port number, and returns a client that can be used to interact with said client.

// `connect` returns a Promise
connect(portNumber).then(function(client) {

});

Example

var connect = require('node-firefox-connect');

connect(1234)
  .then(function(client) {
    // Let's show for example all the running apps
    client.getWebapps(function(err, webapps) {
      webapps.listRunningApps(function(err, apps) {
        console.log("Running apps:", apps);
      });
    });
  });

History

This is based on initial work on fxos-connect by Nicola Greco.