Skip to content

sznowicki/uptime-check

Repository files navigation

Uptime check

npm version Coverage Status

Checks uptime status of given url and provided keyword (optional).

How it works

Makes simple curl requests, gathers data on response and if requested also is looking for a keyword inside the document body.

If http code (response) is 2xx website is considered "up". If there is a keyword given for search, but the keyword cannot be found in the document body, website is considered "down".

v4 migration

From version 4 there is no userAgent option any more. If you used this, please migrate to:

check({
  headers: {
      'User-Agent': 'Your custom UA string',
  }
});

Example usage

check({
  url: 'https://example.com',
  keyword: 'example',
  redirectsLimit: 0
})
  .then(result => {
    /*
        see index.d.ts:Result
    */
  })
  .catch((err) => {
    /*
    err = '{Error} unexpected error.';
    */
  });

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •