Normalize a URL
Useful when you need to display, store, deduplicate, sort, compare, etc, URLs.
$ npm install normalize-url
```js const normalizeUrl = require('normalize-url');
normalizeUrl('sindresorhus.com'); //=> 'http://sindresorhus.com'
normalizeUrl('HTTP://xn--xample-hva.com:80/?b=bar&a=foo'); //=> 'http://êxample.com/?a=foo&b=bar' ```
Type: string
URL to normalize.
Type: Object
Type: string
Default: http:
Type: boolean
Default: true
Prepends defaultProtocol to the URL if it's protocol-relative.
```js normalizeUrl('//sindresorhus.com:80/'); //=> 'http://sindresorhus.com'
normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false}); //=> '//sindresorhus.com' ```
Type: boolean
Default: false
Normalizes https: URLs to http:.
```js normalizeUrl('https://sindresorhus.com:80/'); //=> 'https://sindresorhus.com'
normalizeUrl('https://sindresorhus.com:80/', {normalizeHttps: true}); //=> 'http://sindresorhus.com' ```
Type: boolean
Default: false
Normalizes http: URLs to https:.
```js normalizeUrl('https://sindresorhus.com:80/'); //=> 'https://sindresorhus.com'
normalizeUrl('http://sindresorhus.com:80/', {normalizeHttp: true}); //=> 'https://sindresorhus.com' ```
This option can't be used with the forceHttp option at the same time.
Type: boolean
Default: true
Removes hash from the URL.
```js normalizeUrl('sindresorhus.com/about.html#contact'); //=> 'http://sindresorhus.com/about.html'
normalizeUrl('sindresorhus.com/about.html#contact', {stripHash: false}); //=> 'http://sindresorhus.com/about.html#contact' ```
Type: boolean
Default: true
Removes www. from the URL.
```js normalizeUrl('http://www.sindresorhus.com/about.html#contact'); //=> 'http://sindresorhus.com/about.html#contact'
normalizeUrl('http://www.sindresorhus.com/about.html#contact', {stripWWW: false}); //=> 'http://www.sindresorhus.com/about.html#contact' ```
Type: Array<RegExp|string>
Default: [/^utm_\w+/i]
Removes query parameters that matches any of the provided strings or regexes.
js
normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {
removeQueryParameters: ['ref']
});
//=> 'http://sindresorhus.com/?foo=bar'
Type: boolean
Default: true
Removes trailing slash.
Note: Trailing slash is always removed if the URL doesn't have a pathname.
```js normalizeUrl('http://sindresorhus.com/redirect/'); //=> 'http://sindresorhus.com/redirect'
normalizeUrl('http://sindresorhus.com/redirect/', {removeTrailingSlash: false}); //=> 'http://sindresorhus.com/redirect/'
normalizeUrl('http://sindresorhus.com/', {removeTrailingSlash: false}); //=> 'http://sindresorhus.com' ```
Type: boolean Array<RegExp|string>
Default: false
Removes the default directory index file from path that matches any of the provided strings or regexes. When true, the regex /^index\.[a-z]+$/ is used.
js
normalizeUrl('www.sindresorhus.com/foo/default.php', {
removeDirectoryIndex: [/^default\.[a-z]+$/]
});
//=> 'http://sindresorhus.com/foo'
Type: boolean
Default: true
Sorts the query parameters alphabetically by key.
js
normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {
sortQueryParameters: false
});
//=> 'http://sindresorhus.com/?b=two&a=one&c=three'
MIT © Sindre Sorhus