Skip to content

Latest commit

 

History

History
121 lines (90 loc) · 3.07 KB

README.md

File metadata and controls

121 lines (90 loc) · 3.07 KB
Raw

Website Health Checker

Website Health Guesser NPM module

Build Status Coverage Status NPM version

Install

You can install it globally for commande usage:

$ npm install -g website-health-checker

or as a normal dependency:

$ npm install -S website-health-checker

Command Line

$ website-health-checker --help

Usage: website-health-guesser <url> [options][-?, --help]

Options:
  --version           Show version number                              [boolean]
  --certified, --hon  Optional: website should be HON certified        [boolean]
  --lang, -l          Optional: CountryCode of the expected languages. ie: en fr [array]
  --ip                Optional: Website should respond from this ip
  --contains          Optional: Page should contains those words
  --blacklist         Optional: List of suspicious words                 [array]
  --url, -u           url to check                                    [required]
  -?, --help          Show help                                        [boolean]

Usage

const healthChecker = require('website-health-guesser');

healthChecker.isHealthy('https://www.example.com/', {
    certified: true, // Must be Honcode certified
    lang: ['en', 'fr'], // Must be in English or in French
    contains: 'example.com', // Must contain "example.com" string
  }).then(function(result) {
    console.log(result);
    /*
      result: {
        availability: true,
        certified: false,
        lang: true,
        contains: true,
      }
    */
});

API

.isHealthy(url, expectations)

Type: function

Parameters:

url: Url to test
expectations: {
     available: true,
     certifed: true, // Honcode certification
     lang: [countryCodes],
     ip: 127.0.0.1,
     contains: 'string that must be here',
     blacklist: [forbidden, words],
}

All expectations are optional.

Return a Promise with booleans for all tested expectations.

See Also

Contributing to Website Health Checker

Contributions are always welcome, no matter how large or small.

See Contributing.

Developer

License

Apache License 2.0