Security News
Opengrep Emerges as Open Source Alternative Amid Semgrep Licensing Controversy
Opengrep forks Semgrep to preserve open source SAST in response to controversial licensing changes.
By Sarah Gooding - Jan 28, 2025
New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
What is parse-url?
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.
What are parse-url's main functionalities?
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);Other packages similar to parse-url
url-parse
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.
qs
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.
urijs
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.
parse-url
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.
:cloud: Installation
# Using npm
npm install --save parse-url
# Using yarn
yarn add parse-url
:clipboard: Example
// Dependencies
import parseUrl from "parse-url";
console.log(parseUrl("http://ionicabizau.net/blog"))
// {
// protocols: [ 'http' ],
// protocol: 'http',
// port: '',
// resource: 'ionicabizau.net',
// user: '',
// password: '',
// pathname: '/blog',
// hash: '',
// search: '',
// href: 'http://ionicabizau.net/blog',
// query: {}
// }
console.log(parseUrl("http://domain.com/path/name?foo=bar&bar=42#some-hash"))
// {
// protocols: [ 'http' ],
// protocol: 'http',
// port: '',
// resource: 'domain.com',
// user: '',
// password: '',
// pathname: '/path/name',
// hash: 'some-hash',
// search: 'foo=bar&bar=42',
// href: 'http://domain.com/path/name?foo=bar&bar=42#some-hash',
// query: { foo: 'bar', bar: '42' }
// }
// 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: '',
// resource: 'host.xz',
// user: 'git',
// password: '',
// pathname: '/path/name.git',
// hash: '',
// search: '',
// href: 'git+ssh://git@host.xz/path/name.git',
// query: {}
// }
console.log(parseUrl("git@github.com:IonicaBizau/git-stats.git", false))
// {
// protocols: [ 'ssh' ],
// protocol: 'ssh',
// port: '',
// resource: 'github.com',
// user: 'git',
// password: '',
// pathname: '/IonicaBizau/git-stats.git',
// hash: '',
// search: '',
// href: 'git@github.com:IonicaBizau/git-stats.git',
// query: {}
// }
:question: Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
interopDefaultLegacy()
#PURE
parseUrl(url, normalize)
Parses the input url.
Note: This throws if invalid urls are provided.
Params
-
String
url: The input url. -
Boolean|Object
normalize: Whether to normalize the url or not. Default isfalse. Iftrue, the url will be normalized. If an object, it will be the options object sent tonormalize-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).host(String): The fully qualified domain name of a network host, or its IP address.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.parse_failed(Boolean): Whether the parsing failed or not.
GIT_RE
([a-zA-Z_][a-zA-Z0-9_-]{0,31}) Try to match the user ([\w.-@]+) Match the host/resource (([~,.\w,-,_,/,\s]|%[0-9A-Fa-f]{2})+?(?:.git|/)?) Match the path, allowing spaces/white
:yum: How to contribute
Have an idea? Found a bug? See how to contribute.
:sparkling_heart: Support my projects
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 coffeetea. :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:
:dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
@_nomtek/react-native-shimmer-animation@aabelmann/ui-layer@ali5049/react-native-buttons@amirdiafi/react-native-ios-haptics@angga30prabu/wa-modified@apardellass/react-native-audio-stream@aysea/react-native-ui-library@azalpacir/react-native-dhp-printer@brantalikp/rn-resize@buganto/client@con-test/react-native-concent-common@cs6/react-native-test-native-view-library@damruravihara/react-native-testing-package@dataparty/api@enkeledi/react-native-week-month-date-picker@extrieve_technologies/quickcapture_react_native@foundernetes/machines@foundernetes/metal-debian@geeky-apo/react-native-advanced-clipboard@hbglobal/react-native-actions-shortcuts@heycharge/heycharge-react-native-sdk@hieuquang2212/form@hstech/utils@idas1/ui-component-lib@jfilipe-sparta/react-native-module_2@jimengio/mocked-proxy@klevn/solid-router@lakutata-module/service@mockswitch/cli@ndla/source-map-resolver@npm_fluentco/adflow-react-native-sdk@oiti/rn-liveness2d@open-wa/wa-automate@phpboyscout/semantic-release-gitlab@phuocnb/semrelease-gitlab@positionex/position-sdk@praella/localisationist@qiwi/sourcecrumbs@react-native-ui-design/button@roq/ui-react@roshub/api@saad27/react-native-bottom-tab-tour@semantic-release/gitlab@sephriot/react-native-persistable-uri@sidghimire/react-native-mapbox-navigation@taingo97/react-native-awesome-module@taingo97/react-native-bluetooth-xprinter@taingo97/react-native-expo-key-rsa-kt@taingo97/react-native-generate-key-rsa@taingo97/react-native-key-rsa@taingo97/react-native-print-xprinter@taingo97/react-native-rsa-expo@taingo97/react-native-sunmi-printer@taingo97/react-native-telpo-printer@teles1-semantic-release/gitlab@thinxviewx/core-rn@tomw2w/my-nuxt-layer@valifysolutions/react-native-vidvliveness@wecraftapps/react-native-use-keyboardagent-get-agentangularvezbaapaas-trackapi-reach-react-native-fixarchlibraryarifbudixzastra-ufo-sdkawesome-module-kdba-js-cookie-bannerbeggbilibili2localbiometric-stbirken-react-native-community-image-editorblitzzzbuild-plugin-ssrcandlelabssdkcheckbox-componentcli-live-tutorialdelta-screendemo-test-scrndeploy-versioningdesign-system-trial-milyasbpadogandev-simple-toastegg-muc-custom-loaderelectron-infoeval-spiderexpo-renavigatefawaterak-online-paymentfawatrak-online-paymentfixed_form_builderfluent.adflow.reactnativesdkfluent.adflow.reactnativesdk-alphafmslframework_test_library_sixdeeframework_test_library_sixdee_newframework_test_library_sixdee_new_newfuge-runnergamification-integration-newgaurav-react-native-loopgenerator-bootstrap-boilerplate-templategenz-native-elementsgh-monoproject-cligit-upgitlab-backup-util-harduinogriffin-ui-libraryheroku-wp-environment-synchologithong1-utilshubot-will-it-connecthui-plugin-wssipsamveljamuskalimjordy-frijters-test-libkakapokhaled-salem-custom-componentsluojia-cli-devmarkdownalint-cli2michael-stunmicrobe.jsmiguelcostero-ng2-toastynative-apple-loginnative-date-picker-modulenative-google-loginnative-kakao-loginnative-modal-damage-vehiclenative-zipndla-source-map-resolvernew-awesome-4321njs-wa-autonormalize-idnormalize-sshnpm_one_12_34_1_npm_one_1_2_3npm_one_2_2npm_qwertyparse-db-uripasbeaucoupmoinsravepayutestingpnm-yph-react-native-custom-componentsproject-wajs-dvpyreswap-sdkquickcapture_react_nativeraact-native-arunramya151reac-native-arun-ramya-testreact-native-additionreact-native-android-video-player-viewreact-native-animate-textreact-native-app-bubblereact-native-app-integrity-checksumreact-native-arps-authorize-netreact-native-arun-ramya-testreact-native-arunjeyam1987react-native-arunmeena1987react-native-arunramya151react-native-auth-service-clientreact-native-aventonfacetec-aventonreact-native-awesome-android-123react-native-awesome-android-123-zeotapreact-native-awesome-module-latestreact-native-awesome-module-tworeact-native-azure-communication-servicesreact-native-badge-controlreact-native-basic-appreact-native-basic-screenreact-native-biometric-authenticatereact-native-bleccs-componentsreact-native-bluetooth-device-detectreact-native-bridge-packagereact-native-bubble-chartreact-native-build-vesion-getterreact-native-check-componentreact-native-chenaarreact-native-components-designreact-native-conekta-card-tokenizerreact-native-contact-listreact-native-cplusreact-native-create-video-thumbnailreact-native-ctp-odpreact-native-dhp-printerreact-native-dimensions-layoutreact-native-dsphoto-modulereact-native-fedlight-dsmreact-native-flyyreact-native-get-countriesreact-native-ghn-ekycreact-native-innity-2react-native-innity-remasterreact-native-input-libraryreact-native-is7react-native-jsi-device-inforeact-native-kakao-mapsreact-native-klarify-iosreact-native-klarify-uireact-native-klcreact-native-lib-test-rn-1react-native-library-testing-422522react-native-line-login-androidreact-native-login-demo-testreact-native-lowlatencyreact-native-loyalty-platformsreact-native-manh-testreact-native-manual-ios-sdkreact-native-modal-progress-barreact-native-module-argereact-native-module-for-testingreact-native-multiplier-altroncosoreact-native-multiplier-componentreact-native-multiplier-demoreact-native-multiplier2react-native-multiplyreact-native-multiply-componentreact-native-multiselectorreact-native-mun-kitreact-native-my-first-try-arun-ramyareact-native-native-audio-enginereact-native-native-ios-test1react-native-nativewindreact-native-nghia-shareringreact-native-nice-learningreact-native-omental-frameworkreact-native-onrampreact-native-payu-payment-testingreact-native-plugpag-wrapperreact-native-progress-arrowreact-native-pulsator-nativereact-native-rabbitmq-allreact-native-radio-bic-group-libreact-native-reanimated-sortable-listreact-native-recent-framework-updatereact-native-responsive-helperreact-native-responsive-sizereact-native-return-usb-datareact-native-rn-appreact-native-rn-icons-libraryreact-native-rom-componentsreact-native-rtn-ips-poslin-testreact-native-sandycomponentreact-native-savczuk-feature-libraryreact-native-sayhello-modulereact-native-screen-idle-timerreact-native-scroll-tab-to-indexreact-native-shared-gesturereact-native-simple-timelinereact-native-sixdee_test_libreact-native-sp-test-commonreact-native-teknoctrl-componentsreact-native-test-comlibraryreact-native-test-module-hhhreact-native-test-viewreact-native-ticker-tapereact-native-tone-frameworkreact-native-transtracker-libraryreact-native-ui-components-libraryreact-native-uvc-camera-androidreact-native-version-appreact-native-volume-phisicalreact-native-withframework-checkreact-native-wtfreact-native-xiaomi-permissionsreact-native-xprinter-thermal-blereact-native-ytximkitreactnativelyreat-native-multiplierkprrefinejs-reporn-adyen-dropinrn-agora-ios-mrn-circular-chartrn-counter-demorn-session-multiplier-demorn-tm-notifyrn_unique_device_idrobots-agentrocompsmart_one_connectsoajs.repositoriessourcecrumbsstunsushi-sdk-ftmtest-haptik-libtest-zeo-collectts-scrapertumblr-texturl-localvision-camera-base64-resizedvision-camera-plugin-face-detectorvision-camera-plugin-scan-facesvrt-clivue-cli-plugin-ice-buildervue-cli-plugin-ut-builderwa-frikzwander-cliwarp-apiwarp-serverweb-yii2wifi_configuration_packageworkpadxbuilder-formsxl-git-upyangtao-jszeo-collectzzzxxxyyy321123
:scroll: License
FAQs
An advanced url parser supporting git urls too.
The npm package parse-url receives a total of 1,793,645 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.
Package last updated on 03 Apr 2024
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.
Related posts
Security News
Node.js EOL Versions CVE Dubbed the "Worst CVE of the Year" by Security Experts
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
By Sarah Gooding - Jan 24, 2025
Security News
cURL Project and Go Security Teams Reject CVSS as Broken
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
By Sarah Gooding - Jan 24, 2025