Examples and supplementary documentation for Nightmare
Clone or download
Latest commit e0c8d40 Jan 4, 2017
Permalink
Failed to load latest commit information.
docs Merge pull request #37 from GautierT/patch-2 Jan 5, 2017
examples Merge pull request #29 from rosshinkley/3-action May 30, 2016
.gitignore initial commit Mar 4, 2016
CHANGELOG.md 0.3.3 Jan 5, 2017
README.md changelog touchups, 0.3.0 May 30, 2016
package.json 0.3.3 Jan 5, 2017

README.md

nightmare-examples

This project contains supplementary examples and documentation for Nightmare JS.

Documentation

Getting Started

New to Nightmare? The most basic way to use it is with promises or callbacks. Here are a few examples:

Nightmare and Generators

Several JavaScript libraries use generators to give you a simpler way to deal with asynchronous events. Here’s how to use Nightmare with some of them:

Extending Nightmare

Nightmare may not do everything out of the box that you need it to do.

  • .action() - Look here if adding a method that does a specific activity in the browser.
  • .use() - Wrap several actions up for reusability in one tidy place.

Common Pitfalls

Working with an automated web browser can be complex. Here are a few common gotchas and issues you might run into while working with Nightmare:

Known Issues

Here are some known problems with Nightmare:

Examples

All pages above have accompanying scripts you can actually run. To get started, you’ll need to make sure you install their dependencies first by running npm install.

After that, all the examples are runnable using node [example].

Additions and Corrections

If something has been missed, needs correcting, or you have a question, feel free to open an issue or pull request.