Package Exports

jsdom-global

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jsdom-global) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

jsdom-global

Enables DOM in Node.js

jsdom-global will inject document, window and other DOM API into your Node.js environment. Useful for running, in Node.js, tests that are made for browsers.

Install

Requires jsdom.

npm install --save-dev --save-exact jsdom jsdom-global

Usage

Just invoke it to turn your Node.js environment into a DOM environment.

require('jsdom-global')()

// you can now use the DOM
document.body.innerHTML = 'hello'

To clean up after itself, just invoke the function it returns.

var cleanup = require('jsdom-global')()

// do things

cleanup()

You can also invoke it with a function block so it'll clean up afterwards.

var jsdom = require('jsdom-global')

jsdom(function () {
  var $ = require('jquery')
  $('body').html('hello')
})

Tape

In tape, run it before your other tests.

require('jsdom-global')()

test('your tests', (t) => {
  /* and so on... */
})

Mocha

Just add it to mocha's before and after hooks.

before(function () {
  this.jsdom = require('jsdom-global')()
})

after(function () {
  this.jsdom()
})

Browserify

If you use Browserify on your tests (eg: smokestack, tape-run, budo, hihat, zuul, and so on), doing require('jsdom-global')() is a noop. In practice, this means you can use jsdom-global even if your tests are powered by browserify, and your test will now work in both the browser and Node.

Writing your tests (test.js):

require('jsdom-global')()

// ...do your tests here

Running it with smokestack:

browserify test.js | smokestack          # run in a browser
node test.js                             # or the console
browserify test.js --no-bundle-external  # also works (but why bother?)

Running it with Babel (babelify or babel-cli):

browserify test.js -t babelify | smokestack  # run in a browser (with babel)
babel-node test.js                           # or the console

Thanks

ricostacruz.com · GitHub @rstacruz · Twitter @rstacruz