52 lines
1.7 KiB
JavaScript
52 lines
1.7 KiB
JavaScript
"use strict"
|
|
|
|
const parsePath = require("parse-path")
|
|
, normalizeUrl = require("normalize-url")
|
|
|
|
/**
|
|
* parseUrl
|
|
* Parses the input url.
|
|
*
|
|
* **Note**: This *throws* if invalid urls are provided.
|
|
*
|
|
* @name parseUrl
|
|
* @function
|
|
* @param {String} url The input url.
|
|
* @param {Boolean|Object} normalize Wheter to normalize the url or not.
|
|
* Default is `false`. If `true`, the url will
|
|
* be normalized. If an object, it will be the
|
|
* options object sent to [`normalize-url`](https://github.com/sindresorhus/normalize-url).
|
|
*
|
|
* For SSH urls, normalize won't work.
|
|
*
|
|
* @return {Object} An object containing the following fields:
|
|
*
|
|
* - `protocols` (Array): An array with the url protocols (usually it has one element).
|
|
* - `protocol` (String): The first protocol, `"ssh"` (if the url is a ssh url) or `"file"`.
|
|
* - `port` (null|Number): The domain port.
|
|
* - `resource` (String): The url domain (including subdomains).
|
|
* - `user` (String): The authentication user (usually for ssh urls).
|
|
* - `pathname` (String): The url pathname.
|
|
* - `hash` (String): The url hash.
|
|
* - `search` (String): The url querystring value.
|
|
* - `href` (String): The input url.
|
|
* - `query` (Object): The url querystring, parsed as object.
|
|
*/
|
|
function parseUrl(url, normalize = false) {
|
|
if (typeof url !== "string" || !url.trim()) {
|
|
throw new Error("Invalid url.")
|
|
}
|
|
if (normalize) {
|
|
if (typeof normalize !== "object") {
|
|
normalize = {
|
|
stripHash: false
|
|
}
|
|
}
|
|
url = normalizeUrl(url, normalize)
|
|
}
|
|
const parsed = parsePath(url)
|
|
return parsed;
|
|
}
|
|
|
|
module.exports = parseUrl;
|