The parse-url npm package is used to parse URLs and extract components such as protocol, auth, host, pathname, query parameters, and hash. It provides a simple API to break down a URL string into its constituent parts for easy access and manipulation.
Parsing the URL
This feature allows you to parse a full URL and returns an object with properties like protocol, resource, user, pathname, hash, search, and query. Each property represents a specific part of the URL.
const parseUrl = require('parse-url');
const parsed = parseUrl('https://www.example.com:8080/path/name?query=value#hash');
console.log(parsed);Parsing the Query String
This feature specifically focuses on parsing the query string part of the URL and converting it into an object for easy access to each query parameter.
const parseUrl = require('parse-url');
const parsed = parseUrl('https://www.example.com/path/name?query=value&another=thing');
console.log(parsed.query);Reconstructing the URL
After parsing a URL and potentially modifying its components, this feature allows you to reconstruct the URL back into a string.
const parseUrl = require('parse-url');
const parsed = parseUrl('https://www.example.com/path/name');
parsed.resource = 'www.another-example.com';
const reconstructedUrl = parseUrl.stringify(parsed);
console.log(reconstructedUrl);The url-parse package offers similar functionality to parse-url, allowing for the parsing of URLs into components. It also provides the ability to resolve relative URLs against an absolute base URL, which is a feature not present in parse-url.
While qs is not a direct alternative to parse-url, it provides robust query string parsing and stringifying capabilities. It can be used in conjunction with other URL parsing libraries to handle the query string part of URLs more extensively than parse-url.
URI.js is a URL manipulation library that provides a fluent API for building, parsing, and manipulating URLs. It offers more features than parse-url, such as URL normalization, resolution of relative paths, and support for punycode and IPv6.
An advanced url parser supporting git urls too.
For low-level path parsing, check out parse-path. This very module is designed to parse urls. By default the urls are normalized.
# Using npm
npm install --save parse-url
# Using yarn
yarn add parse-url
// Dependencies
const parseUrl = require("parse-url")
console.log(parseUrl("http://ionicabizau.net/blog"))
// { protocols: [ 'http' ],
// protocol: 'http',
// port: null,
// resource: 'ionicabizau.net',
// user: '',
// pathname: '/blog',
// hash: '',
// search: '',
// href: 'http://ionicabizau.net/blog' }
console.log(parseUrl("http://domain.com/path/name?foo=bar&bar=42#some-hash"))
// { protocols: [ 'http' ],
// protocol: 'http',
// port: null,
// resource: 'domain.com',
// user: '',
// pathname: '/path/name',
// hash: 'some-hash',
// search: 'foo=bar&bar=42',
// href: 'http://domain.com/path/name?foo=bar&bar=42#some-hash' }
// If you want to parse fancy Git urls, turn off the automatic url normalization
console.log(parseUrl("git+ssh://git@host.xz/path/name.git", false))
// { protocols: [ 'git', 'ssh' ],
// protocol: 'git',
// port: null,
// resource: 'host.xz',
// user: 'git',
// pathname: '/path/name.git',
// hash: '',
// search: '',
// href: 'git+ssh://git@host.xz/path/name.git' }
console.log(parseUrl("git@github.com:IonicaBizau/git-stats.git", false))
// { protocols: [],
// protocol: 'ssh',
// port: null,
// resource: 'github.com',
// user: 'git',
// pathname: '/IonicaBizau/git-stats.git',
// hash: '',
// search: '',
// href: 'git@github.com:IonicaBizau/git-stats.git' }
There are few ways to get help:
parseUrl(url, normalize)Parses the input url.
Note: This throws if invalid urls are provided.
String url: The input url.
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.
For SSH urls, normalize won't work.
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.Have an idea? Found a bug? See how to contribute.
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! :heart:
If you are using this library in one of your projects, add it in this list. :sparkles:
git-uplienstunkakapo@open-wa/wa-automatefuge-runnerurl-localparse-db-uriwarp-apiwarp-serverrobots-agentnormalize-sshxl-git-upnormalize-idegg-muc-custom-loaderhologitvrt-clinative-zipnormalize-ssh-urleval-spiderts-scrapermicrobe.jshubot-will-it-connectdeploy-versioningxbuilder-formstumblr-textssh-host-managerblitzzzwander-cligraphmilkerapi-reach-react-native-fix@roshub/apiverify-aws-sns-signature@apardellass/react-native-audio-streaml2forlernareact-native-plugpag-wrapperreact-native-pulsator-native@hstech/utilsreact-native-kakao-maps@geeky-apo/react-native-advanced-clipboardnative-apple-loginnative-google-login@jprustv/sulla-hotfixvue-cli-plugin-ice-builder@hemith/react-native-tnkworkpadreact-native-contact-list@corelmax/react-native-my2c2p-sdk@dataparty/apiheroku-wp-environment-syncreact-native-responsive-sizedelta-screenreact-native-test-module-hhhreact-native-is7@kriblet/wa-automate@mergulhao/wa-automate@jimengio/mocked-proxycli-live-tutorial@buganto/client@datalogic/react-native-datalogic-module@ndla/source-map-resolverbirken-react-native-community-image-editornative-kakao-loginreact-native-modal-progress-bar@hawkingnetwork/react-native-tab-viewmiguelcostero-ng2-toastyvue-cli-plugin-ut-buildercv-app-payment-adyendrowl-base-theme-iconsetgitlab-backup-util-harduinoloastrn-custom-tabviewhomebridge-pushcuttersoajs.repositoriesFAQs
An advanced url parser supporting git urls too.
The npm package parse-url receives a total of 1,637,638 weekly downloads. As such, parse-url popularity was classified as popular.
We found that parse-url demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.