website-health-checker

    1.0.2 • Public • Published

    Website Health Checker

    Website Health Checker 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-checker <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]
      -?, --help          Show help                                        [boolean]
     

    Usage

    const healthChecker = require('website-health-checker');
     
    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

    Install

    npm i website-health-checker

    DownloadsWeekly Downloads

    2

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    67.1 kB

    Total Files

    18

    Last publish

    Collaborators

    • avatar