sindresorhus

normalize-url

kevva

		Prepends `defaultProtocol` to the URL if it's protocol-relative.

		normalizeUrl('//sindresorhus.com:80/');

		normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false});

		normalizeUrl('https://sindresorhus.com:80/');

		normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true});

		This option can't be used with the `forceHttp` option at the same time.

		normalizeUrl('http://sindresorhus.com:80/', {forceHttps: true});

		Strip the [authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) part of a URL.

		normalizeUrl('user:password@sindresorhus.com');

		normalizeUrl('user:password@sindresorhus.com', {stripAuthentication: false});

		//=> 'https://user:password@sindresorhus.com'

		readonly stripAuthentication?: boolean;

		normalizeUrl('sindresorhus.com/about.html#contact');

		//=> 'http://sindresorhus.com/about.html#contact'

		normalizeUrl('sindresorhus.com/about.html#contact', {stripHash: true});

		//=> 'http://sindresorhus.com/about.html'

		Removes HTTP(S) protocol from an URL `http://sindresorhus.com` → `sindresorhus.com`.

		normalizeUrl('https://sindresorhus.com');

		normalizeUrl('sindresorhus.com', {stripProtocol: true});

		If a boolean is provided, `true` will remove all the query parameters.

		normalizeUrl('www.sindresorhus.com?foo=bar', {

		`false` will not remove any query parameter.

		normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', {

		//=> 'http://www.sindresorhus.com/?foo=bar&ref=test_ref&utm_medium=test'

		readonly removeQueryParameters?: ReadonlyArray<RegExp | string>;

		readonly removeQueryParameters?: ReadonlyArray<RegExp | string> | boolean;

		__Note__: Trailing slash is always removed if the URL doesn't have a pathname unless the `removeSingleSlash` option is set to `false`.

		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});

		readonly removeTrailingSlash?: boolean;

		Remove a sole `/` pathname in the output. This option is independant of `removeTrailingSlash`.

		normalizeUrl('https://sindresorhus.com/');

		normalizeUrl('https://sindresorhus.com/', {removeSingleSlash: 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.

		normalizeUrl('www.sindresorhus.com/foo/default.php', {

			removeDirectoryIndex: [/^default\.[a-z]+$/]

		readonly removeDirectoryIndex?: ReadonlyArray<RegExp | string>;

		Sorts the query parameters alphabetically by key.

		normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {

		//=> 'http://sindresorhus.com/?b=two&a=one&c=three'

		readonly sortQueryParameters?: boolean;

[Normalize](https://en.wikipedia.org/wiki/URL_normalization) a URL.

@param url - URL to normalize, including [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).

import normalizeUrl = require('normalize-url');

normalizeUrl('//www.sindresorhus.com:80/../baz?b=bar&a=foo');

//=> 'http://sindresorhus.com/baz?a=foo&b=bar'

declare function normalizeUrl(url: string, options?: normalizeUrl.Options): string;

// https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs

const DATA_URL_DEFAULT_MIME_TYPE = 'text/plain';

const DATA_URL_DEFAULT_CHARSET = 'us-ascii';

const testParameter = (name, filters) => {

	return filters.some(filter => filter instanceof RegExp ? filter.test(name) : filter === name);

const normalizeDataURL = (urlString, {stripHash}) => {

	const match = /^data:(?<type>[^,]*?),(?<data>[^#]*?)(?:#(?<hash>.*))?$/.exec(urlString);

		throw new Error(`Invalid URL: ${urlString}`);

	if (mediaType[mediaType.length - 1] === 'base64') {

	const mimeType = (mediaType.shift() || '').toLowerCase();

			let [key, value = ''] = attribute.split('=').map(string => string.trim());

				if (value === DATA_URL_DEFAULT_CHARSET) {

			return `${key}${value ? `=${value}` : ''}`;

	if (normalizedMediaType.length !== 0 || (mimeType && mimeType !== DATA_URL_DEFAULT_MIME_TYPE)) {

	return `data:${normalizedMediaType.join(';')},${isBase64 ? data.trim() : data}${hash ? `#${hash}` : ''}`;

const normalizeUrl = (urlString, options) => {

		return normalizeDataURL(urlString, options);

		throw new Error('`view-source:` is not supported as it is a non-standard protocol');

	const hasRelativeProtocol = urlString.startsWith('//');

	const isRelativeUrl = !hasRelativeProtocol && /^\.*\//.test(urlString);

		urlString = urlString.replace(/^(?!(?:\w+:)?\/\/)|^\/\//, options.defaultProtocol);

	if (options.removeQueryParameters === true) {

		urlObj.pathname = urlObj.pathname.replace(/\/$/, '');

	// Take advantage of many of the Node `url` normalizations

	if (!options.removeSingleSlash && urlObj.pathname === '/' && !oldUrlString.endsWith('/') && urlObj.hash === '') {

		urlString = urlString.replace(/\/$/, '');

	// Remove ending `/` unless removeSingleSlash is false

	if ((options.removeTrailingSlash || urlObj.pathname === '/') && urlObj.hash === '' && options.removeSingleSlash) {

	// Restore relative protocol, if applicable

	if (hasRelativeProtocol && !options.normalizeProtocol) {

		urlString = urlString.replace(/^http:\/\//, '//');

		urlString = urlString.replace(/^(?:https?:)?\/\//, '');

	"repository": "sindresorhus/normalize-url",

	"funding": "https://github.com/sponsors/sindresorhus",

# normalize-url [![Coverage Status](https://codecov.io/gh/sindresorhus/normalize-url/branch/main/graph/badge.svg)](https://codecov.io/gh/sindresorhus/normalize-url)

> [Normalize](https://en.wikipedia.org/wiki/URL_normalization) a URL

Useful when you need to display, store, deduplicate, sort, compare, etc, URLs.

*If you need to use this in the browser, use version 4: `npm i normalize-url@4`*

const normalizeUrl = require('normalize-url');

URL to normalize, including [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).

Prepend `defaultProtocol` to the URL if it's protocol-relative.

normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false});

normalizeUrl('https://sindresorhus.com:80/');

normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true});

normalizeUrl('http://sindresorhus.com:80/', {forceHttps: true});

This option can't be used with the `forceHttp` option at the same time.

Strip the [authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) part of the URL.

Type: `Array<RegExp | string> | boolean`\

Remove query parameters that matches any of the provided strings or regexes.

normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {

If a boolean is provided, `true` will remove all the query parameters.

normalizeUrl('www.sindresorhus.com?foo=bar', {

`false` will not remove any query parameter.

normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', {

//=> 'http://www.sindresorhus.com/?foo=bar&ref=test_ref&utm_medium=test'

**Note:** Trailing slash is always removed if the URL doesn't have a pathname unless the `removeSingleSlash` option is set to `false`.

normalizeUrl('http://sindresorhus.com/redirect/');

normalizeUrl('http://sindresorhus.com/redirect/', {removeTrailingSlash: false});

normalizeUrl('http://sindresorhus.com/', {removeTrailingSlash: false});

Remove a sole `/` pathname in the output. This option is independant of `removeTrailingSlash`.

normalizeUrl('https://sindresorhus.com/');

normalizeUrl('https://sindresorhus.com/', {removeSingleSlash: false});

Type: `boolean | Array<RegExp | string>`\

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.

normalizeUrl('www.sindresorhus.com/foo/default.php', {

	removeDirectoryIndex: [/^default\.[a-z]+$/]

Sorts the query parameters alphabetically by key.

normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {

//=> 'http://sindresorhus.com/?b=two&a=one&c=three'

- [compare-urls](https://github.com/sindresorhus/compare-urls) - Compare URLs by first normalizing them

		<a href="https://tidelift.com/subscription/pkg/npm-normalize-url?utm_source=npm-normalize-url&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>

		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.

		@@ -158,4 +158,22 @@ declare namespace normalizeUrl {
		```

		If a boolean is provided, `true` will remove all the query parameters.

		```
		normalizeUrl('www.sindresorhus.com?foo=bar', {
		removeQueryParameters: true
		});
		//=> 'http://sindresorhus.com'
		```

		`false` will not remove any query parameter.

		```
		normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', {
		removeQueryParameters: false
		});
		//=> 'http://www.sindresorhus.com/?foo=bar&ref=test_ref&utm_medium=test'
		```
		*/
		readonly removeQueryParameters?: ReadonlyArray<RegExp \| string>;
		readonly removeQueryParameters?: ReadonlyArray<RegExp \| string> \| boolean;

		@@ -162,0 +180,0 @@ /**

		@@ -176,2 +176,6 @@ 'use strict';

		if (options.removeQueryParameters === true) {
		urlObj.search = '';
		}

		// Sort query parameters
		@@ -178,0 +182,0 @@ if (options.sortQueryParameters) {

		{
		"name": "normalize-url",
		"version": "6.0.1",
		"version": "6.1.0",
		"description": "Normalize a URL",
		@@ -5,0 +5,0 @@ "license": "MIT",

		@@ -178,3 +178,3 @@ # normalize-url [![Coverage Status](https://codecov.io/gh/sindresorhus/normalize-url/branch/main/graph/badge.svg)](https://codecov.io/gh/sindresorhus/normalize-url)

		Type: `Array<RegExp \| string>`\
		Type: `Array<RegExp \| string> \| boolean`\
		Default: `[/^utm_\w+/i]`
		@@ -191,2 +191,20 @@

		If a boolean is provided, `true` will remove all the query parameters.

		```js
		normalizeUrl('www.sindresorhus.com?foo=bar', {
		removeQueryParameters: true
		});
		//=> 'http://sindresorhus.com'
		```

		`false` will not remove any query parameter.

		```js
		normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', {
		removeQueryParameters: false
		});
		//=> 'http://www.sindresorhus.com/?foo=bar&ref=test_ref&utm_medium=test'
		```

		##### removeTrailingSlash
		@@ -193,0 +211,0 @@

Improved metrics