status-is-ok's Introduction

Status-is-ok

Check if the url is 200-A-Ok 🎈

Installation

npm: npm install status-is-ok yarn: yarn add status-is-ok

Usage

Function

const IsOk = require('status-is-ok')
IsOk('http://xkcd.com')

Callback

const IsOk = require('status-is-ok')
const isUrlOk = new IsOk()
isUrlOk.check('http://xkcd.com', callback)

Promise

const IsOk = require('status-is-ok')
const isUrlOk = new IsOk();
isUrlOk.check('http://xkcd.com')
  .then(function)
  .catch(function)

The module exposes just a single function:

.check(url, [callback])

this checks the url is ok, and will return a promise or return via the callback if one is specified

The callback and promise will return an object with the following keys:

{
  isOk: boolean | returns false on a failure
  status: status code returned | returns 404 on a failure
  message: status message
  error: any errors encountered | empty on a successful check
}

Development

linting yarn lint // or npm run lint running the test suite yarn test // or npm test

Todo

check if the requested url is 200 status (OK)
write some tests
handle arrays
cli

License

MIT license

status-is-ok's People

Contributors

Stargazers

Watchers

status-is-ok's Issues

callback not coming back for a made up website

I randomly wrote a non existing website name and the callback gave me an error.

(node:14468) UnhandledPromiseRejectionWarning: #<Object>
(node:14468) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 2)
(node:14468) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the 
Node.js process with a non-zero exit code.

Recommend Projects