normalize-url 6.0.1 → 6.1.0

package/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.

package/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();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "normalize-url",
-	"version": "6.0.1",
+	"version": "6.1.0",
 	"description": "Normalize a URL",
 	"license": "MIT",
 	"repository": "sindresorhus/normalize-url",

package/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`\