msedgedriver

Node MS Edge Driver

An NPM wrapper for Selenium MSEdgeDriver.

Building and Installing

npm install msedgedriver

Or grab the source and

node ./install.js

What this is really doing is just grabbing a particular "blessed" (by this module) version of MSEdgeDriver. As new versions are released and vetted, this module will be updated accordingly.

The package has been set up to fetch and run MSEdgeDriver for MacOS (darwin), Linux based platforms (as identified by Node.js), and Windows. If you spot any platform weirdness, let us know or send a patch.

Force download

By default this package, when installed, will search for an existing MSEdgeDriver binary in your configured temp directory. If found, and it is the correct version, it will simply copy it to your node_modules directory. You can force it always download by configuring it:

npm install msedgedriver --edgechromiumdriver-force-download

Or add property into your .npmrc file.

edgechromiumdriver_force_download=true

Another option is to use PATH variable EDGECHROMIUMDRIVER_FORCE_DOWNLOAD.

EDGECHROMIUMDRIVER_FORCE_DOWNLOAD=true npm install msedgedriver

Custom binaries url

To use a mirror of the MSEdgeDriver binaries use npm config property edgechromiumdriver_cdnurl. Default is https://msedgedriver.azureedge.net/.

npm install msedgedriver --edgechromiumdriver_cdnurl=https://msedgedriver.azureedge.net/

Or add property into your .npmrc file.

edgechromiumdriver_cdnurl=https://msedgedriver.azureedge.net/

Another option is to use PATH variable EDGECHROMIUMDRIVER_CDNURL.

EDGECHROMIUMDRIVER_CDNURL=https://msedgedriver.azureedge.net/ npm install msedgedriver

Custom binaries file

To get the msedgedriver from the filesystem instead of a web request use the npm config property EDGECHROMIUMDRIVER_FILEPATH.

npm install msedgedriver --EDGECHROMIUMDRIVER_FILEPATH=/path/to/msedgedriver_mac64.zip

Or add property into your .npmrc file.

EDGECHROMIUMDRIVER_FILEPATH=/path/to/msedgedriver_mac64.zip

Another option is to use the PATH variable EDGECHROMIUMDRIVER_FILEPATH

EDGECHROMIUMDRIVER_FILEPATH=/path/to/msedgedriver_mac64.zip

This variable can be used to set either a .zip file or the binary itself, eg:

EDGECHROMIUMDRIVER_FILEPATH=/bin/msedgedriver

Custom download options

Install through a proxy.

npm config set proxy http://[user:pwd]@domain.tld:port
npm config set https-proxy http://[user:pwd]@domain.tld:port

Use different User-Agent.

npm config set user-agent "Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Firefox/52.0"

Skipping msedgedriver download

You may wish to skip the downloading of the msedgedriver binary file, for example if you know for certain that it is already there or if you want to use a system binary and just use this module as an interface to interact with it.

To achieve this you can use the npm config property edgechromiumdriver_skip_download.

npm install msedgedriver --edgechromiumdriver_skip_download=true

Or add property into your .npmrc file.

edgechromiumdriver_skip_download=true

Another option is to use the PATH variable EDGECHROMIUMDRIVER_SKIP_DOWNLOAD

EDGECHROMIUMDRIVER_SKIP_DOWNLOAD=true

Running

bin/msedgedriver [arguments]

And npm will install a link to the binary in node_modules/.bin as it is wont to do.

Running with Selenium WebDriver

require('msedgedriver');
var webdriver = require('selenium-webdriver');
var driver = new webdriver.Builder()
  .forBrowser('chrome')
  .build();

(Tested for selenium-webdriver version 2.48.2)

The path will be added to the process automatically, you don't need to configure it. But you can get it from require('msedgedriver').path if you want it.

Running via node

The package exports a path string that contains the path to the msedgedriver binary/executable.

Below is an example of using this package via node.

var childProcess = require('child_process');
var chromiumedgedriver = require('msedgedriver');
var binPath = chromiumedgedriver.path;

var childArgs = [
  'some argument'
];

childProcess.execFile(binPath, childArgs, function(err, stdout, stderr) {
  // handle results
});

You can also use the start and stop methods:

var chromiumedgedriver = require('msedgedriver');

args = [
	// optional arguments
];
chromiumedgedriver.start(args);
// run your tests
chromiumedgedriver.stop();

With the latest version, you can optionally receive a Promise from the chromiumedgedriver.start function:

var returnPromise = true;
chromiumedgedriver
  .start(args, returnPromise)
  .then(() => {
    console.log('chromiumedgedriver is ready');
  });

Note: if your tests are ran asynchronously, chromiumedgedriver.stop() will have to be executed as a callback at the end of your tests

Versioning

The NPM package version tracks the version of msedgedriver that will be installed, with an additional build number that is used for revisions to the installer. You can use the package version number to install a specific version, or use the setting to a specific version. If there is a new Edge Driver version available which is not yet available as a version of msedgedriver, the npm command npm run update-msedgedriver in this repository can be used to make the required updates to this module, please submit the change as a PR. To always install the latest version of MSEdgedriver, use LATEST as the version number:

npm install msedgedriver --edgechromiumdriver_version=LATEST

Or add property into your .npmrc file.

edgechromiumdriver_version=LATEST

Another option is to use env variable EDGECHROMIUMDRIVER_VERSION.

EDGECHROMIUMDRIVER_VERSION=LATEST npm install msedgedriver

A Note on msedgedriver

MSEdgedriver is not a library for NodeJS.

This is an NPM wrapper and can be used to conveniently make MSEdgedriver available. It is not a Node.js wrapper.

Supported Node.js versions

We will do our best to support every supported Node.js versions. See nodejs/Release for the current supported versions. You can also view our build scripts and check the versions there.

Contributing

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.

We have added VS Code Remote support with containers. If you are on Windows, set git config core.autocrlf input so you don't get git errors.

Author

Giovanni Bassi, with collaboration from lots of good people.

Thanks for Obvious and their PhantomJS project for heavy inspiration! Check their project on Github.

License

Licensed under the Apache License, Version 2.0.