https://github.com/unstubbable/universal-parse-url
🔗 A universal URL parser for Node.js and browser environments with a minimal footprint.
https://github.com/unstubbable/universal-parse-url
universal url-parser
Last synced: about 1 month ago
JSON representation
🔗 A universal URL parser for Node.js and browser environments with a minimal footprint.
- Host: GitHub
- URL: https://github.com/unstubbable/universal-parse-url
- Owner: unstubbable
- License: mit
- Created: 2017-01-12T14:27:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-22T11:48:35.000Z (over 7 years ago)
- Last Synced: 2025-05-13T02:15:56.405Z (about 1 month ago)
- Topics: universal, url-parser
- Language: TypeScript
- Homepage:
- Size: 44.9 KB
- Stars: 8
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# universal-parse-url
[![NPM][npm-image]][npm-url]
[![Travis Build Status][travis-image]][travis-url]
[![Commitizen Friendly][commitizen-image]][commitizen-url]
[![MIT License][license-image]][license-url]
[![Sauce Labs Build Status][saucelabs-image]][saucelabs-url]
A universal URL parser for Node.js and browser environments with a minimal footprint (gzipped **only 600 bytes** for the browser version).
## Installation
Install with `npm`:
```sh
npm install --save universal-parse-url
```
**Note:** The installed node module also includes a `d.ts` file, and thus works out of the box with **TypeScript**.
## Usage
```js
import { parseURL } from 'universal-parse-url';
const url = parseURL('http://www.example.com:1234/foo?bar=1#baz');
```
The resulting `url` object looks like this:
```
{
hash: '#baz',
host: 'www.example.com:1234',
hostname: 'www.example.com',
href: 'http://www.example.com:1234/foo?bar=1#baz',
pathname: '/foo',
port: '1234',
protocol: 'http:',
search: '?bar=1'
}
```
## How It Works
- In Node.js `parseURL` just delegates to [URL.parse][].
- In browser environments:
- An [HTMLAnchorElement][] is created initially (with `document.createElement('a')`).
- When `parseURL` is called, the `href` attribute of this element is set to the given url string.
- The element is then used to extract the URL details.
## Requirements
If you plan on targeting browser environments as well, you need to use a bundler like [Webpack][], [Browserify][] or [Rollup][] (with [rollup-plugin-node-resolve][]) that makes use of the `browser` field in the `package.json`.
## Caveats
To keep `universal-parse-url` as small and simple as possible, only the URL details that are available in Node’s `URL` object as well as `HTMLAnchorElement` are supported (see the above example).
[npm-image]: https://img.shields.io/npm/v/universal-parse-url.svg
[npm-url]: https://www.npmjs.com/package/universal-parse-url
[travis-image]: https://img.shields.io/travis/KingHenne/universal-parse-url.svg
[travis-url]: https://travis-ci.org/KingHenne/universal-parse-url
[license-image]: https://img.shields.io/github/license/kinghenne/universal-parse-url.svg
[license-url]: https://github.com/KingHenne/universal-parse-url/blob/master/LICENSE
[commitizen-image]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]: http://commitizen.github.io/cz-cli/
[saucelabs-image]: https://saucelabs.com/browser-matrix/KingHenne.svg
[saucelabs-url]: https://saucelabs.com/u/KingHenne
[URL.parse]: https://nodejs.org/dist/latest-v6.x/docs/api/url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost
[HTMLAnchorElement]: https://developer.mozilla.org/de/docs/Web/API/HTMLAnchorElement
[Webpack]: https://webpack.js.org
[Browserify]: http://browserify.org
[Rollup]: http://rollupjs.org
[rollup-plugin-node-resolve]: https://github.com/rollup/rollup-plugin-node-resolve