Detect the browser versions available on your system and launch them in an isolated profile for automated testing purposes.
At the beginning of time, there was substack/browser-launcher,
and all was well with the world. However, life happened, and the project became unmaintained.
Out of the ashes, a leader emerged, and promised the citizens of
browser-launcher would become great again,
but under a new banner:
The world was once again prosperous, until we were eventually notified that
the king had forsaken us (which
happens, it's open source, and
benderjs did a lot for the community, which is awesome!)
Anyways, due to the project's dependence on
james-proxy forked the project to make some
much-needed updates and fix some problems.
Differences from browser-launcher
- contains fixes and pull requests for unresolved issues reported in original repository
launcher.browsersis an array of local browsers only, not an object as it was before
launchcallback returns an
Instanceinstead of a child process, see API section for more details
- uses win-detect-browsers for browser detection on Windows
- more browsers supported
Differences from browser-launcher2
- This repository is not dead
The goal for this module is to support all major browsers on every desktop platform.
At the moment,
james-browser-launcher supports following browsers on Windows, Unix and OS X:
- IE (Windows only)
npm install james-browser-launcher
var launcher = ;;
$ node example/launch.js Instance started with PID: 12345 Instance stopped with exit code: 0
var launcher = ;launcher;
$ node example/detect.jsAvailable browsers:[
Detaching the launched browser process from your script
If you want the opened browser to remain open after killing your script, first, you need to set
true (see the API). By default, killing your script will kill the opened browsers.
Then, if you want your script to immediately return control to the shell, you may additionally call
unref on the
instance object in the callback:
var launcher = ;;
var launcher = ;
Detect available browsers and pass
launch function to the callback.
configPath- path to a browser configuration file (Optional)
callback(err, launch)- function called with
launchfunction and errors (if any)
launch(uri, options, callback)
Open given URI in a browser and return an instance of it.
uri- URI to open in a newly started browser
options- configuration options or name of a browser to launch
options.browser- name of a browser to launch
options.version- version of a browser to launch, if none was given, the highest available version will be launched
options.proxy- URI of the proxy server
options.options- additional command line options
options.skipDefaults- don't supply any default options to browser
options.detached- if true, then killing your script will not kill the opened browser
options.noProxy- set proxy routes to skip over
options.headless- run a browser in a headless mode (only if Xvfb available)
callback(err, instance)- function fired when started a browser
instanceor an error occurred
This property contains an array of all known and available browsers.
Browser instance object.
command- command used to start the instance
args- array of command line arguments used while starting the instance
image- instance's image name
processName- instance's process name
process- reference to instance's process started with Node's
pid- instance's process PID
stdout- instance's process STDOUT stream
stderr- instance's process STDERR stream
stop- fired when instance stops
stop(callback)- stop the instance and fire the callback once stopped
Detects all browsers available.
callback(available)- function called with array of all recognized browsers
Each browser contains following properties:
name- name of a browser
version- browser's version
type- type of a browser i.e. browser's family
command- command used to launch a browser
Updates the browsers cache file (
~/.config/james-browser-launcher/config.json is no
configFile was given) and creates new profiles for found browsers.
configFile- path to the configuration file Optional
callback(err, browsers)- function called with found browsers and errors (if any)
- IE8: after several starts and stops, if you manually open IE it will come up with a pop-up asking if we want to restore tabs (#21)
- Chrome @ OSX: it's not possible to launch multiple instances of Chrome at once