Jsdomify-compat NPM

jsdomify-compat

A ready to use DOM instance right at your finger tips for easy and fast testing without any browser in node.js environment (with mocha, for example)

This is the compatibility version of jsdomify which can run in node.js version 0.10 and 0.12, using JSDOM version 3.1.2

Getting started

npm install --save-dev jsdomify-compat

Usage

You can create a new jsdom instance simply with

var jsdomify = require('jsdomify-compat').create();

Or you can provide a valid HTML string that will be used as your DOM

var jsdomify = require('jsdomify').create(
  '<!DOCTYPE html><html><head></head><body>hello</body></html>'
);

Methods

jsdomify expose some useful methods that can be used to control the DOM instance

create(domString)

jsdomify.create();

Create a new DOM instance (with or without the optional DOM string).

clear()

jsdomify.clear();

Clear the current instance and recreate a new one using the same DOM string (basically clearing up the DOM).

destroy()

jsdomify.destroy([clearRequireCache]);

Close the window and destroy the document. Can be used to isolate the tests and prevent leaking from one test suite to another.

If clearRequireCache === true all the cached node require modules will be purged (defaults to true).
This is needed in order to use ReactJS with MochaJS.

Related issues:

getDocument()

var documentRef = jsdomify.getDocument();
var elm = documentRef.getElementById('whatever');

Get a reference to the document that has been created as a global.
Useful when running with strict linting that doesn't allow globals but still want to test things on the document itself.

Usage examples

From our very own test suite

describe('Isolation test', function() {

  before(function() {
    jsdomify.create();
  });

  beforeEach(function() {
    jsdomify.clear();
  });

  after(function() {
    jsdomify.destroy();
  });

  it('should append a child to the body', function() {

    var par = document.createElement("P");
    var text = document.createTextNode("some text");
    par.appendChild(text);
    document.body.appendChild(par);
    var parCount = document.getElementsByTagName("P");

    expect(document.body.innerHTML, 'not to be empty');
    expect(parCount.length, 'to be', 1);
  });

  it('should not find the previously appended child', function() {

    var parCount = document.getElementsByTagName("P");

    expect(document.body.innerHTML, 'to be empty');
    expect(parCount.length, 'to be', 0);
  });

});

Test

npm test

License

MIT

jsdom dom test html testing mocha

jsdom

@everything-registry/sub-chunk-1980

1.0.0

9 years ago