Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
"It sure would be neat if PhantomJS was a NodeJS module", I hear you say. Well, wait no longer! This node module implements a nauseously clever bridge between Phantom and Node, so that you can use all your favourite PhantomJS functions without leaving NPM behind and living in a cave.
First, make sure PhantomJS is installed. This module expects the phantomjs
binary to be in PATH somewhere. In other words, type this:
$ phantomjs
If that works, so will phantomjs-node. It's only been tested with PhantomJS 1.3, and almost certainly doesn't work with anything older.
Install it like this:
npm install phantom
For a brief introduction continue reading, otherwise go to the Wiki page for more information!
Use it like this in Coffeescript:
phantom = require 'phantom'
phantom.create (ph) ->
ph.createPage (page) ->
page.open "http://www.google.com", (status) ->
console.log "opened google? ", status
page.evaluate (-> document.title), (result) ->
console.log 'Page title is ' + result
ph.exit()
In Javascript:
var phantom = require('phantom');
phantom.create(function (ph) {
ph.createPage(function (page) {
page.open("http://www.google.com", function (status) {
console.log("opened google? ", status);
page.evaluate(function () { return document.title; }, function (result) {
console.log('Page title is ' + result);
ph.exit();
});
});
});
});
It would use dnode
with weak
module by default. It means that you need to setup node-gyp
with Microsoft VS2010 or VS2012, which is a huge installation on Windows.
dnodeOpts
property could help you to control dnode settings, so you could disable weak
by setting it false
to avoid that complicated installations.
var phantom = require('phantom');
phantom.create(function (ph) {
ph.createPage(function (page) {
/* the page actions */
});
}, {
dnodeOpts: {
weak: false
}
});
You can use all the methods listed on the PhantomJS API page
Due to the async nature of the bridge, some things have changed, though:
page.evaluate
) are returned in a callback insteadpage.render()
takes a callback so you can tell when it's done writing the filepage.get('version', callback)
or page.set('viewportSize', {width:640,height:480})
, etc. Nested objects can be accessed by including dots in keys, such as page.set('settings.loadImages', false)
page.set('callbackName', callback)
, e.g. page.set('onLoadFinished', function(success) {})
request.abort()
, request.changeUrl(url)
, and request.setHeader(key,value)
. The second argument is the callback which can execute in the scope of your code, with access to just the requestData. e.g.page.onResourceRequested(
function(requestData, request) { request.abort(); },
function(requestData) { console.log(requestData.url) }
);
ph.createPage()
makes new PhantomJS WebPage objects, so use that if you want to open lots of webpages. You can also make multiple phantomjs processes by calling phantom.create('flags', { port: someDiffNumber})
multiple times, so if you need that for some crazy reason, knock yourself out!
Also, you can set exit callback, which would be invoked after phantom.exit()
or after phantom process crash:
phantom.create('flags', { port: 8080, onExit: exitCallback})
You can also pass command line switches to the phantomjs process by specifying additional args to phantom.create()
, eg:
phantom.create '--load-images=no', '--local-to-remote-url-access=yes', (page) ->
##Note for Mac users
Phantom requires you to have the XCode Command Line Tools installed on your box, or else you will get some nasty errors (xcode
not found or make
not found). If you haven't already, simply install XCode through the App Store, then install the command line tools.
Don't ask. The things these eyes have seen.
I will answer that question with a question. How do you communicate with a process that doesn't support shared memory, sockets, FIFOs, or standard input?
Well, there's one thing PhantomJS does support, and that's opening webpages. In fact, it's really good at opening web pages. So we communicate with PhantomJS by spinning up an instance of ExpressJS, opening Phantom in a subprocess, and pointing it at a special webpage that turns socket.io messages into alert()
calls. Those alert()
calls are picked up by Phantom and there you go!
The communication itself happens via James Halliday's fantastic dnode library, which fortunately works well enough when combined with browserify to run straight out of PhantomJS's pidgin Javascript environment.
If you'd like to hack on phantom, please do! You can run the tests with cake test
or npm test
, and rebuild the coffeescript/browserified code with cake build
. You might need to npm install -g coffee-script
for cake to work.
FAQs
PhantomJS integration module for NodeJS
The npm package phantom receives a total of 13,046 weekly downloads. As such, phantom popularity was classified as popular.
We found that phantom demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.