@cliqz-oss/node-firefox-connect

Connect to a Firefox simulator

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
44Mar 29, 2019Jan 13, 2015Minified + gzip package size for @cliqz-oss/node-firefox-connect in KB

Readme

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.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.