README.md

hyperlink-parser

HyperlinkParser.js is an util to parse the URLs. Can be used in Node.js and the browsers. The properties of the parsed URL is same as the properties of HTMLHyperlinkElementUtils. For more details, please read the following example.

Installation

npm i hyperlink-parser

Example

import HyperlinkParser from 'hyperlink-parser'

const link = HyperlinkParser.parse('https://user:[email protected]:8080/search?q=javascript#results")

console.log(link)

The result is a plain object containing following properties.

{
  "href": "https://user:[email protected]:8080/search?q=javascript#results",
  "origin": "https://example.com:8080",
  "protocol": "https:",
  "username": "user",
  "password": "pass",
  "host": "example.com:8080",
  "hostname": "example.com",
  "port": "8080",
  "pathname": "/search",
  "search": "?q=javascript",
  "hash": "#results"
}

The stringify method is designed to build a url from an object, for example:

const url = HyperlinkParser.stringify({
  "href": "https://user:[email protected]:8080/search?q=javascript#results",
  "origin": "https://example.com:8080",
  "protocol": "https:",
  "username": "user",
  "password": "pass",
  "host": "example.com:8080",
  "hostname": "example.com",
  "port": "8080",
  "pathname": "/search",
  "search": "?q=javascript",
  "hash": "#results"
})

console.log(url)

// https://user:[email protected]:8080/search?q=javascript#results

License

MIT