Headless Gecko with JS API
An NPM wrapper for SlimerJS, a scriptable browser for web development and testing.
SlimerJS runs on Gecko, the browser engine behind Mozilla Firefox, and aims to be a simple, drop-in replacement for phantomjs. Because SlimerJS uses the version of firefox passed in the
SLIMERJSLAUNCHER environment variable, edge builds of firefox can be used. This can be useful for viewing and testing modern web functionality which is not yet available in phantomjs.
npm install slimerjs
Or grab the source and
What this is really doing is just grabbing a particular "blessed" (by this module) version of Slimer. As new versions of Slimer are released and vetted, this module will be updated accordingly.
The package has been set up to fetch and run Slimer for MacOS (darwin), Linux based platforms (as identified by nodejs), and -- as of version 0.2.0 -- Windows (thanks to Domenic Denicola). If you spot any platform weirdnesses, let us know or send a patch.
bin/slimerjs [slimer arguments]
And npm will install a link to the binary in
it is wont to do.
The package exports a
path string that contains the path to the
Below is an example of using this package via node.
var path = require'path'var childProcess = require'child_process'var slimerjs = require'slimerjs'var binPath = slimerjspathvar childArgs =pathjoin__dirname 'slimerjs-script.js''some other argument (passed to slimerjs script)'childProcessexecFilebinPath childArgs// handle results
The NPM package version tracks the version of SlimerJS that will be installed, with an additional build number that is used for revisions to the installer.
0.9.1-2 will both install SlimerJs 0.9.1 but the latter
has newer changes to the installer.
By default, this package will download slimerjs from
This should work fine for most people.
If this site is down, or the Great Firewall is blocking it, you may need to use
a download mirror. To set a mirror, set npm config property
Default is ``.
npm install slimerjs --slimerjs_cdnurl=https://download.slimerjs.org/releases
Or add property into your
.npmrc file (https://www.npmjs.org/doc/files/npmrc.html)
Another option is to use PATH variable
SLIMERJS_CDNURL=https://download.slimerjs.org/releases npm install slimerjs
If you plan to install slimerjs many times on a single machine, you can
slimerjs binary on PATH. The installer will automatically detect
and use that for non-global installs.
SlimerJS is not a library for NodeJS. It's a separate environment and code written for node is unlikely to be compatible. In particular SlimerJS does not expose a Common JS package loader.
This is an NPM wrapper and can be used to conveniently make Slimer available It is not a Node JS wrapper.
Standalone SlimerJS scripts can be driven from within a node program by spawning SlimerJS in a child process.
Read the SlimerJS FAQ for more details: https://slimerjs.org/faq.html
This is NPM's way of telling you that it was not able to start a process. It usually means:
nodeis not on your PATH, or otherwise not correctly installed.
taris not on your PATH. This package expects
taron your PATH on Linux-based platforms.
Check your specific error message for more information.
This error means that NPM was not able to install phantomjs to the file system. There are three major reasons why this could happen:
npm cache cleanto fix them.
This error means that something went wrong with your internet connection, and the installer was not able to download the SlimerJS binary for your platform. Please try again.
Do you live in China, or a country with an authoritarian government? We've seen problems where the GFW or local ISP blocks https://slimerjs.org, preventing the installer from downloading the binary.
Try visiting the the download page manually.
If that page is blocked, you can try using a different CDN with the
env variable described above.
You can tell NPM and the SlimerJS installer to skip validation of ssl keys with NPM's strict-ssl setting:
npm set strict-ssl false
WARNING: Turning off
strict-ssl leaves you vulnerable to attackers reading
your encrypted traffic, so run this at your own risk!
If you install SlimerJS manually, and put it on PATH, the installer will try to use the manually-installed binaries.
Some Linux distros tried to rename
nodejs due to a package
conflict. This is a non-portable change, and we do not try to support this. The
recommends that you run
apt-get install nodejs-legacy to symlink
on those platforms, or many NodeJS programs won't work properly.
Questions, comments, bug reports, and pull requests are all welcome. Submit them at the project on GitHub.
Bug reports that include steps-to-reproduce (including code) are the best. Even better, make them in the form of pull requests.
Copyright 2012 The Obvious Corporation.
Licensed under the Apache License, Version 2.0.
See the top-level file