webcheck-mirror v1.0.0

webcheck-mirror

A mirroring plugin for webcheck.

How to install

npm install --save webcheck-mirror

How to use

var Webcheck = require('webcheck');
var MirrorPlugin = require('webcheck-mirror');

var plugin = MirrorPlugin({
    dest: __dirname + '/mirrored'
    ignoreQuery: false,
});

var webcheck = new Webcheck();
webcheck.addPlugin(plugin);

plugin.enable();

// now continue with your code...

Options

• filterUrl: Filter urls that should only crawled once (default all urls).
• ignoreQuery: Ignore query in url.

Note for filters

Filters are regular expressions, but the plugin uses only the .test(str) method to proof. You are able to write your own and much complexer functions by writing the logic in the test method of an object like this:

opts = {
   filterSomething: {
       test: function (val) {
           return false || true;
       }
   }
}

Methods

• reset(undefined | url): Reset a specific url, or the complete ignore list
• ignore(url): Add a resource to ignore list
• check(url): Check if a resource is ignored