Accept a boolean for the removeQueryParameters option (#136)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
sindresorhus · Jun 22, 2021 · 6216336 · 6216336
1 parent 305e3f2
commit 6216336
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -155,8 +155,26 @@ declare namespace normalizeUrl {
 		});
 		//=> 'http://sindresorhus.com/?foo=bar'
 		```
+
+		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;
 
 		/**
 		Removes trailing slash.

diff --git a/index.js b/index.js
@@ -173,6 +173,10 @@ const normalizeUrl = (urlString, options) => {
 		}
 	}
 
+	if (options.removeQueryParameters === true) {
+		urlObj.search = '';
+	}
+
 	// Sort query parameters
 	if (options.sortQueryParameters) {
 		urlObj.searchParams.sort();

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -15,6 +15,12 @@ normalizeUrl('http://www.sindresorhus.com', {stripWWW: false});
 normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {
 	removeQueryParameters: ['ref', /test/]
 });
+normalizeUrl('www.sindresorhus.com?foo=bar', {
+	removeQueryParameters: true
+});
+normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', {
+	removeQueryParameters: false
+});
 normalizeUrl('http://sindresorhus.com/', {removeTrailingSlash: false});
 normalizeUrl('http://sindresorhus.com/', {removeSingleSlash: false});
 normalizeUrl('www.sindresorhus.com/foo/default.php', {

diff --git a/readme.md b/readme.md
@@ -175,7 +175,7 @@ normalizeUrl('http://www.sindresorhus.com', {stripWWW: false});
 
 ##### removeQueryParameters
 
-Type: `Array<RegExp | string>`\
+Type: `Array<RegExp | string> | boolean`\
 Default: `[/^utm_\w+/i]`
 
 Remove query parameters that matches any of the provided strings or regexes.
@@ -187,6 +187,24 @@ normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {
 //=> 'http://sindresorhus.com/?foo=bar'
 ```
 
+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
 
 Type: `boolean`\

diff --git a/test.js b/test.js
@@ -119,6 +119,28 @@ test('removeQueryParameters option', t => {
 	t.is(normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', options), 'http://www.sindresorhus.com/?foo=bar');
 });
 
+test('removeQueryParameters boolean `true` option', t => {
+	const options = {
+		stripWWW: false,
+		removeQueryParameters: true
+	};
+
+	t.is(normalizeUrl('http://www.sindresorhus.com', options), 'http://www.sindresorhus.com');
+	t.is(normalizeUrl('www.sindresorhus.com?foo=bar', options), 'http://www.sindresorhus.com');
+	t.is(normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', options), 'http://www.sindresorhus.com');
+});
+
+test('removeQueryParameters boolean `false` option', t => {
+	const options = {
+		stripWWW: false,
+		removeQueryParameters: false
+	};
+
+	t.is(normalizeUrl('http://www.sindresorhus.com', options), 'http://www.sindresorhus.com');
+	t.is(normalizeUrl('www.sindresorhus.com?foo=bar', options), 'http://www.sindresorhus.com/?foo=bar');
+	t.is(normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', options), 'http://www.sindresorhus.com/?foo=bar&ref=test_ref&utm_medium=test');
+});
+
 test('forceHttp option', t => {
 	const options = {forceHttp: true};
 	t.is(normalizeUrl('https://sindresorhus.com'), 'https://sindresorhus.com');