README.md

sleepyhollow-phantom

PhantomJS binder for two-way communication with Node.js. An IPC library in two modules, used in conjunction with sleepyhollow-node, via stdin and stderr. No socket.io or server-page hacks required.

usage

To receive messages from Node.js, require and invoke sleepyhollow. This returns an EventEmitter instance which allows you to implement your own message passing system.

// this is PhantomJS code, not Node.js code!

var sleepyhollow = require('../index.js');
var mrhyde = sleepyhollow();

mrhyde.on('render', function(url) {
    var page = require('webpage').create();
    page.open(url, function(status) {
        page.render(url.replace(/[\/:]/g, "") + ".png");
        mrhyde.emit("rendered");
        page.close();
    });
});

mrhyde.on('end', function() {
    phantom.exit();
});

See the usage example for the corresponding Node.js code.

emit(event, [param])

Arguments:

1. event - String: name of the event
2. param - Mixed: optional, any JSON.stringify()-able value is supported

Returns: null

Example:

myhyde.emit("payload", { prop : page.size });

on(event, listener)

Arguments:

1. event - String: name of the event
2. listener - Function(Mixed): receives a optional JSON.stringify()-able value

Example:

myhyde.on('render', function(obj) {
    page.render("tmp");
})