Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

phonegap-soundwave

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

phonegap-soundwave

Connect middleware to stream a PhoneGap app.

  • 0.7.0
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created

phonegap-soundwave Build Status

Connect middleware to stream a PhoneGap app.

Examples

Standalone

var soundwave = require('phonegap-soundwave');
soundwave.serve();

Express

var soundwave = require('phonegap-soundwave'),
    express = require('express'),
    app = express();

app.use(soundwave());
app.listen(3000);

Connect

var soundwave = require('phonegap-soundwave'),
    connect = require('connect'),
    app = connect();

app.use(soundwave());
app.listen(3000);

HTTP

var soundwave = require('phonegap-soundwave'),
    http = require('http');

var server = http.createServer(soundwave());
server.listen(3000);

API

var soundwave = require('phonegap-soundwave');

soundwave()

Returns a http.Server request listener that is also a compatible connect middleware function.

Returns:

  • {Function} request listener

soundwave.serve(options, [callback])

Creates a local server to serve up the project. The intended receiver is the PhoneGap App but any browser can consume the content.

Options:

  • options
    • port {Number} to listen on (Default: 3000).
    • [autoreload] {Boolean} toggle AutoReload watch (default: true).
  • callback {Function}
    • e {Error} is null unless there is an error.
      • data {Object}
        • server {http.Server} is the server running.
        • address {String} is the server address.
        • port {Number} is the server port.

Events:

  • error is emitted when an error occurs.
  • log is emitted with server log info.

soundwave.create(options)

The project is created from the same app template used by the PhoneGap CLI and Cordova CLI. When a template does not exist, it is fetched and saved in the common directory:

~/.cordova/lib/www/phonegap/VERSION/

Options:

  • options {Object}
    • path {String} is the path to create the project.
    • version {String} defines the PhoneGap app version.

Events:

  • progress emits state while downloading the app template.
    • state {Object} with received, total, and percentage.
  • error emitted when an error occurs.
    • e {Error}
  • complete emits when the project has been created.
    • data {Object} is indentical to the input options.

Example:

soundwave.create({
    path: 'path/to/app',
    version: '3.3.0'
})
.on('progress', function(state) {
    // only emitted when downloading a template.
    // state values are only defined when response supports
    // content-length header.
    if (state.percentage) {
        console.log('downloaded: ' + state.percentage + '%');
    }
}
.on('error', function(e) {
    // handle error
})
.on('complete', function(data) {
    // data.path is the app path
    console.log('created project at: ' + data.path);
});

Keywords

FAQs

Package last updated on 04 Feb 2014

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