is-url-online

A small library that checks if a URL is online or not

Usage no npm install needed!

<script type="module">
  import isUrlOnline from 'https://cdn.skypack.dev/is-url-online';
</script>

README

Is URL Online?

A lightweight library for checking if a url is down or not. Pretty useful while checking if the url inserted is correct one or fake one as normal url checking methods won't work.

Only supports server side apps.

npm bundle size npm node-current npm

Getting started

pnpm install is-url-online

or

npm install is-url-online

or

yarn add is-url-online

Improvements over other libraries

  • Promise based usage.
  • Works on both CommonJs and EsModule based libraries.
  • Smaller install size because of just one dependency.
  • Built using typescript.
  • Catches invalid URLs.
  • Actively maintained.
  • Automated Dependency update and publishing after successful tests.
  • Has helper methods to deal with extra usecases.

Usage

import { isUrlOnline } from "is-url-online";

await isUrlOnline("https://github.com/Unbuttun/is-url-online"); //-> true
//=> true

await isUrlOnline("https://github.com/Unbuttun/notarepo"); //-> false

await isUrlOnline("notaurl"); //-> false

await isUrlOnline("ttps://github.com/Unbuttun/is-url-online abcd"); //-> true
//because of a space in middle.

Utils

Only Check URL String

This helper method will validate the URL string without checking it online.

import { isUrlString } from "is-url-online";

await isUrlString("https://google.com"); //-> true

await isUrlString("https://google.com/404ingURL"); //-> false

await isUrlString("notaurl"); //-> false

It uses URL module under the hood.

Prepend HTTP/HTTPS

This helper method prepend https:// or http:// to humanized URLs like github.com and localhost

import { prependHttp } from "is-url-online";
// HTTPS is enabled by default.
prependHttp({ url: "github.com" }); //-> https://github.com
prependHttp({ url: "github.com", https: false }); //-> http://github.com

Visualization of this Repo.

![Visualization of this repo](./diagram.svg

Author

Unbuttun

References.