urlutil.js

A simple class for parsing and dealing with URLs.

Usage no npm install needed!

<script type="module">
  import urlutilJs from 'https://cdn.skypack.dev/urlutil.js';
</script>

README

URL Util

A simple class for parsing and dealing with URLs.

Developing

Install necessary dependencies by running npm install.

To build the project simply run gulp. This will run babel on the JS and export bundles to the dist/ folder. This also updates README.md with the latest API documentation.

API Reference

UrlUtil~UrlUtil

Kind: inner class of UrlUtil

~UrlUtil
- new UrlUtil()
- .getScheme(input) ⇒ String
- .hasScheme(input) ⇒ Boolean
- .isNotURL(input) ⇒ Boolean
- .getUrlFromInput(input) ⇒ String
- .isURL(input) ⇒ Boolean
- .isViewSourceUrl(input) ⇒ Boolean
- .isDataUrl(input) ⇒ Boolean
- .isImageDataUrl(input) ⇒ Boolean
- .getUrlFromViewSourceUrl(input) ⇒ String
- .getViewSourceUrlFromUrl(input) ⇒ String
- .getHostname(input) ⇒ String

new UrlUtil()

A simple class for parsing and dealing with URLs.

UrlUtil.getScheme(input) ⇒ `String`

Extracts the scheme from a value.

Kind: static method of UrlUtil
Returns: String - The found scheme.

Param	Type	Description
input	`String`	The input value.

UrlUtil.hasScheme(input) ⇒ `Boolean`

Checks if an input has a scheme (e.g., http:// or ftp://).

Kind: static method of UrlUtil
Returns: Boolean - Whether or not the input has a scheme.

Param	Type	Description
input	`String`	The input value.

UrlUtil.isNotURL(input) ⇒ `Boolean`

Checks if a string is not a URL.

Kind: static method of UrlUtil
Returns: Boolean - Returns true if this is not a valid URL.

Param	Type	Description
input	`String`	The input value.

UrlUtil.getUrlFromInput(input) ⇒ `String`

Converts an input string into a URL.

Kind: static method of UrlUtil
Returns: String - The formatted URL.

Param	Type	Description
input	`String`	The input value.

UrlUtil.isURL(input) ⇒ `Boolean`

Checks if a given input is a valid URL.

Kind: static method of UrlUtil
Returns: Boolean - Whether or not this is a valid URL.

Param	Type	Description
input	`String`	The input URL.

UrlUtil.isViewSourceUrl(input) ⇒ `Boolean`

Checks if a URL is a view-source URL.

Kind: static method of UrlUtil
Returns: Boolean - Whether or not this is a view-source URL.

Param	Type	Description
input	`String`	The input URL.

UrlUtil.isDataUrl(input) ⇒ `Boolean`

Checks if a url is a data url.

Kind: static method of UrlUtil
Returns: Boolean - Whether or not this is a data url.

Param	Type	Description
input	`String`	The input url.

UrlUtil.isImageDataUrl(input) ⇒ `Boolean`

Checks if a url is an image data url.

Kind: static method of UrlUtil
Returns: Boolean - Whether or not this is an image data url.

Param	Type	Description
input	`String`	The input url.

UrlUtil.getUrlFromViewSourceUrl(input) ⇒ `String`

Converts a view-source url into a standard url.

Kind: static method of UrlUtil
Returns: String - A normal url.

Param	Type	Description
input	`String`	The view-source url.

UrlUtil.getViewSourceUrlFromUrl(input) ⇒ `String`

Converts a URL into a view-source URL.

Kind: static method of UrlUtil
Returns: String - The view-source URL.

Param	Type	Description
input	`String`	The input URL.

UrlUtil.getHostname(input) ⇒ `String`

Extracts the hostname or returns undefined.

Kind: static method of UrlUtil
Returns: String - The host name.

Param	Type	Description
input	`String`	The input URL.