scrake v0.1.2

scrake

A simple and dangerous wrapper based upon @tmpvar/jsdom that tries to emulate a lightweight and headless (and limited) browser environment for testing/web scraping.

Inspired by @cheeriojs/cheerio and @ariya/phantomjs, but not restricted to only jQuery, and it does not feature a fully-fledged browser environment.

⚠️WARNING⚠️

By default, scrake will execute all possible resources & scripts to emulate a browser environment as much as possible. Although the actual execution is ran in a different V8 VM context, that still means scrake/jsdom is subject to XSS attack. Malicious users can use this to gain advantage to your Node environment, hence the dangerous in simple and dangerous

In other word, Use scrake at your own risk.

Installation

$ npm install scrake --save <ENTER>

or

$ yarn add scrake <ENTER>

Usage

const scrake = require('scrake')

scrake({ html: '<h2 class="title">Hello world</h2>' }).then(domProps => {
  // domProps === { virtualConsole, cookie, dom, window, document, $ }
})

// if you prefer ES2015:
import scrake from 'scrake'

(async () => {
  let domProps = await scrake({ html: '<h2 class="title">Hello world</h2>' })
  const { virtualConsole, cookie, dom, window, document, $ } = domProps
})()

scrake({ /* html: '', file: '', url: '' */ }, { /* extra options to supply to jsdom */ })

Arguments are passed via object initializer.

One and only one of the major operation argument type could be used, i.e. one of 'html', 'file' and 'url' must be specified and they are mutually exclusive.

Extra options are not validated, and the object is deconstructed and merged after the default options

Known issue

jsdom is generally slower than cheerio, because jsdom is strictly parsing HTML that it has complicated validations. cheerio asserted it has 8x more the performance of jsdom 1.

Fragment is not supported yet, since it does not have a valid jsdom props behind (it is however backed by a shared singleton 2 3)

I still can't get http://www.google.com to work, It tells me a semi-colon is unexpected. I don't know why, probably because of encoding.