query-string 9.5.1 → 10.0.0

package/base.d.ts

@@ -1,6 +1,7 @@
+/* eslint-disable jsdoc/check-param-names -- The `pick()` and `exclude()` doc comments cover both overloads, so they document `filter` as well as `keys` and `options`. The rule only models the first overload. */
 export type ParseOptions = {
 	/**
-	Decode the keys and values. URI components are decoded with [`decode-uri-component`](https://github.com/SamVerschueren/decode-uri-component).
+	Decode the keys and values. A byte that is not valid UTF-8 becomes the replacement character `U+FFFD`, and the bytes around it are still decoded, like the [`URL` parser](https://developer.mozilla.org/en-US/docs/Web/API/URL) and [`URLSearchParams`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) do. A `%` that is not followed by two hexadecimal digits is not an escape and is kept as it is.
 
 	@default true
 	*/
@@ -27,6 +28,8 @@ export type ParseOptions = {
 		//=> {foo: ['1', '2', '3']}
 		```
 
+		Entries without an index, such as `foo[]`, are appended after the highest index seen so far. Appending after an index greater than or equal to `Number.MAX_SAFE_INTEGER` is unsupported.
+
 	- `comma`: Parse arrays with elements separated by comma:
 
 		```
@@ -34,6 +37,21 @@ export type ParseOptions = {
 
 		queryString.parse('foo=1,2,3', {arrayFormat: 'comma'});
 		//=> {foo: ['1', '2', '3']}
+
+		queryString.parse('foo=1,2&foo=3', {arrayFormat: 'comma'});
+		//=> {foo: ['1', '2', '3']}
+		```
+
+		A single value has no separator, so it is a plain value, not an array with one element. Use the `types` option to always get an array, or use `bracket-separator`, which marks arrays explicitly.
+
+		```
+		import queryString from 'query-string';
+
+		queryString.parse('foo=1', {arrayFormat: 'comma'});
+		//=> {foo: '1'}
+
+		queryString.parse('foo=1', {arrayFormat: 'comma', types: {foo: 'string[]'}});
+		//=> {foo: ['1']}
 		```
 
 	- `separator`: Parse arrays with elements separated by a custom character:
@@ -57,16 +75,16 @@ export type ParseOptions = {
 		//=> {foo: ['']}
 
 		queryString.parse('foo[]=1', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
-	 	//=> {foo: ['1']}
+		//=> {foo: ['1']}
 
 		queryString.parse('foo[]=1|2|3', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
 		//=> {foo: ['1', '2', '3']}
 
 		queryString.parse('foo[]=1||3|||6', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
-		//=> {foo: ['1', '', 3, '', '', '6']}
+		//=> {foo: ['1', '', '3', '', '', '6']}
 
 		queryString.parse('foo[]=1|2|3&bar=fluffy&baz[]=4', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
-		//=> {foo: ['1', '2', '3'], bar: 'fluffy', baz:['4']}
+		//=> {bar: 'fluffy', baz: ['4'], foo: ['1', '2', '3']}
 		```
 
 	- `colon-list-separator`: Parse arrays with parameter names that are explicitly marked with `:list`:
@@ -88,17 +106,30 @@ export type ParseOptions = {
 		```
 	*/
 	readonly arrayFormat?:
-	| 'bracket'
-	| 'index'
-	| 'comma'
-	| 'separator'
-	| 'bracket-separator'
-	| 'colon-list-separator'
-	| 'none';
+		| 'bracket'
+		| 'index'
+		| 'comma'
+		| 'separator'
+		| 'bracket-separator'
+		| 'colon-list-separator'
+		| 'none';
 
 	/**
 	The character used to separate array elements when using `{arrayFormat: 'separator'}`.
 
+	Only a literal separator delimits array elements. A percent-encoded separator (for example, `%2C`) is part of the element, which is how `.stringify()` encodes elements that contain the separator. Because of this, `%` and a hexadecimal digit are unsupported, since those also appear inside percent-encoded elements, and so are `&`, `+`, and `#`, since those already have a meaning in a URL: `&` separates parameters, `+` is decoded as a space, and `#` starts the fragment identifier. Those are handled on a best-effort basis, so the result is undefined. Whitespace cannot work at all, since leading and trailing whitespace is ignored when parsing, and a lone surrogate cannot be percent-encoded, so both throw a `TypeError`.
+
+	@example
+	```
+	import queryString from 'query-string';
+
+	queryString.parse('foo=a%2Cb,c', {arrayFormat: 'comma'});
+	//=> {foo: ['a,b', 'c']}
+
+	queryString.parse('foo[]=a%2Cb,c', {arrayFormat: 'bracket-separator'});
+	//=> {foo: ['a,b', 'c']}
+	```
+
 	@default ,
 	*/
 	readonly arrayFormatSeparator?: string;
@@ -106,7 +137,7 @@ export type ParseOptions = {
 	/**
 	Supports both `Function` as a custom sorting function or `false` to disable sorting.
 
-	If omitted, keys are sorted using `Array#sort`, which means, converting them to strings and comparing strings in Unicode code point order.
+	If omitted, keys are sorted using `Array#sort`.
 
 	@default true
 
@@ -130,7 +161,7 @@ export type ParseOptions = {
 	//=> {a: 'one', c: 'three', b: 'two'}
 	```
 	*/
-	readonly sort?: ((itemLeft: string, itemRight: string) => number) | false;
+	readonly sort?: ((itemLeft: string, itemRight: string) => number) | boolean;
 
 	/**
 	Parse the value as a number type instead of string type if it's a number.
@@ -184,7 +215,7 @@ export type ParseOptions = {
 
 	You can also provide a custom function to transform the value. The function will receive the raw string and should return the desired parsed result. When used with array formats (like `comma`, `separator`, `bracket`, etc.), the function is applied to each array element individually.
 
-	NOTE: Array types (`string[]`, `number[]`) are ignored if `arrayFormat` is set to `'none'`.
+	NOTE: With `arrayFormat: 'none'`, array types (`string[]`, `number[]`) do not turn a single value into an array. The value stays a string, and `parseNumbers` and `parseBooleans` do not apply to it. A repeated key is still an array, and its items are parsed with the element type.
 
 	@default {}
 
@@ -199,7 +230,7 @@ export type ParseOptions = {
 			phoneNumber: 'string',
 		}
 	});
-	//=> {phoneNumber: '+380951234567', id: 1}
+	//=> {id: 1, phoneNumber: '+380951234567'}
 	```
 
 	@example
@@ -207,7 +238,8 @@ export type ParseOptions = {
 	```
 	import queryString from 'query-string';
 
-	queryString.parse('?age=20&items=1%2C2%2C3', {
+	queryString.parse('?age=20&items=1,2,3', {
+		arrayFormat: 'comma',
 		parseNumbers: true,
 		types: {
 			items: 'string[]',
@@ -258,16 +290,16 @@ export type ParseOptions = {
 	```
 
 	@example
-	Array types are ignored when `arrayFormat` is set to `'none'`:
+	Array types do not split a single value when `arrayFormat` is set to `'none'`:
 	```
-	queryString.parse('ids=001%2C002%2C003&foods=apple%2Corange%2Cmango', {
+	queryString.parse('ids=001,002,003&foods=apple,orange,mango', {
 		arrayFormat: 'none',
 		types: {
 			ids: 'number[]',
 			foods: 'string[]',
 		},
-	}
-	//=> {ids:'001,002,003', foods:'apple,orange,mango'}
+	});
+	//=> {foods: 'apple,orange,mango', ids: '001,002,003'}
 	```
 
 	@example
@@ -275,7 +307,7 @@ export type ParseOptions = {
 	```
 	import queryString from 'query-string';
 
-	queryString.parse('?ids=001%2C002%2C003&items=1%2C2%2C3&price=22%2E00&numbers=1%2C2%2C3&double=5&number=20', {
+	queryString.parse('?ids=001,002,003&items=1,2,3&price=22.00&numbers=1,2,3&double=5&number=20', {
 		arrayFormat: 'comma',
 		types: {
 			ids: 'string',
@@ -286,33 +318,58 @@ export type ParseOptions = {
 			number: 'number',
 		},
 	});
-	//=> {ids: '001,002,003', items: ['1', '2', '3'], price: '22.00', numbers: [1, 2, 3], double: 10, number: 20}
+	//=> {double: 10, ids: '001,002,003', items: ['1', '2', '3'], number: 20, numbers: [1, 2, 3], price: '22.00'}
 	```
 
 	@example
 	Force `flagged` to be parsed as a boolean even when `parseBooleans` is false:
 	```
 	queryString.parse('?isAdmin=true&flagged=true&isOkay=0', {
-			parseBooleans: false,
-			types: {
-					flagged: 'boolean',
-					isOkay: 'boolean',
-			},
+		parseBooleans: false,
+		types: {
+			flagged: 'boolean',
+			isOkay: 'boolean',
+		},
 	});
-	//=> {isAdmin: 'true', flagged: true, isOkay: false}
+	//=> {flagged: true, isAdmin: 'true', isOkay: false}
 	```
 
 	Note: The `'boolean'` type also converts `'0'` and `'1'` to booleans, and treats valueless keys (e.g. `?flag`) as `true`.
 	*/
 	readonly types?: Record<
-	string,
+		string,
 	'boolean' | 'number' | 'string' | 'string[]' | 'number[]' | ((value: string) => unknown)
 	>;
 };
 
-// eslint-disable-next-line @typescript-eslint/ban-types
+// `parse('foo')` returns `{foo: null}`, so `null` is part of the result and stays in the type.
+// eslint-disable-next-line @typescript-eslint/no-restricted-types
 export type ParsedQuery<T = string> = Record<string, T | null | Array<T | null>>;
 
+type ParsedTypeValue<Type> =
+	Type extends 'number' | 'number[]' ? number
+		: Type extends 'boolean' ? boolean
+			: Type extends (value: string) => infer Result ? Result
+				: never;
+
+/**
+The type of a parsed value, from the `parseNumbers`, `parseBooleans`, and `types` options. A value that does not match its type stays a string.
+
+When `types` is a non-literal value, like a variable typed as `Record<string, ...>`, the value type widens to `unknown` because the specific keys are not known. Pass an object literal to get precise types.
+*/
+type ParsedValue<Options extends ParseOptions> =
+	| string
+	| (Options extends {parseNumbers: true} ? number : never)
+	| (Options extends {parseBooleans: true} ? boolean : never)
+	| (Options extends {types: infer Types} ? ParsedTypeValue<Types[keyof Types]> : never);
+
+/**
+Rejects a property that is not a parse or stringify option. A generic parameter is not checked for excess properties, so without this, a typo like `sortt` in an object literal would compile. Stringify options are allowed, since one options object is often shared by `parse()` and `stringify()`.
+
+It is a mapped type instead of an intersection, so a generic wrapper that forwards its options still compiles. The wrapper gets the plain `string` value type, since its options are not known.
+*/
+type KnownOptions<Options> = {[Key in keyof Options]: Key extends keyof ParseOptions | keyof StringifyOptions ? Options[Key] : never};
+
 /**
 Parse a query string into an object. Leading `?` or `#` are ignored, so you can pass `location.search` or `location.hash` directly.
 
@@ -320,14 +377,11 @@ The returned object is created with [`Object.create(null)`](https://developer.mo
 
 @param query - The query string to parse.
 */
-export function parse(query: string, options: {parseBooleans: true; parseNumbers: true} & ParseOptions): ParsedQuery<string | boolean | number>;
-export function parse(query: string, options: {parseBooleans: true} & ParseOptions): ParsedQuery<string | boolean>;
-export function parse(query: string, options: {parseNumbers: true} & ParseOptions): ParsedQuery<string | number>;
-export function parse(query: string, options?: ParseOptions): ParsedQuery;
+export function parse<Options extends ParseOptions>(query: string, options?: KnownOptions<Options>): ParsedQuery<ParsedValue<Options>>;
 
-export type ParsedUrl = {
+export type ParsedUrl<T = string> = {
 	readonly url: string;
-	readonly query: ParsedQuery;
+	readonly query: ParsedQuery<T>;
 
 	/**
 	The fragment identifier of the URL.
@@ -338,7 +392,7 @@ export type ParsedUrl = {
 };
 
 /**
-Extract the URL and the query string as an object.
+Extract the URL and the query string as an object. Leading and trailing whitespace is ignored.
 
 @param url - The URL to parse.
 @returns An object with a `url` and `query` property.
@@ -356,7 +410,7 @@ queryString.parseUrl('https://foo.bar?foo=bar#xyz', {parseFragmentIdentifier: tr
 //=> {url: 'https://foo.bar', query: {foo: 'bar'}, fragmentIdentifier: 'xyz'}
 ```
 */
-export function parseUrl(url: string, options?: ParseOptions): ParsedUrl;
+export function parseUrl<Options extends ParseOptions>(url: string, options?: KnownOptions<Options>): ParsedUrl<ParsedValue<Options>>;
 
 export type StringifyOptions = {
 	/**
@@ -369,6 +423,8 @@ export type StringifyOptions = {
 	/**
 	[URL encode](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) the keys and values.
 
+	A lone surrogate, which cannot be percent-encoded, is replaced with the replacement character U+FFFD, like `URLSearchParams` does.
+
 	@default true
 	*/
 	readonly encode?: boolean;
@@ -405,7 +461,7 @@ export type StringifyOptions = {
 		queryString.stringify({foo: [1, null, '']}, {arrayFormat: 'comma'});
 		//=> 'foo=1,,'
 		// Note that typing information for null values is lost
-		// and `.parse('foo=1,,')` would return `{foo: [1, '', '']}`.
+		// and `.parse('foo=1,,', {arrayFormat: 'comma'})` would return `{foo: ['1', '', '']}`.
 		```
 
 	- `separator`: Serialize arrays by separating elements with character:
@@ -441,7 +497,7 @@ export type StringifyOptions = {
 		//=> 'foo[]=1||3|6'
 
 		queryString.stringify({foo: [1, 2, 3], bar: 'fluffy', baz: [4]}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
-		//=> 'foo[]=1|2|3&bar=fluffy&baz[]=4'
+		//=> 'bar=fluffy&baz[]=4&foo[]=1|2|3'
 		```
 
 	- `colon-list-separator`: Serialize arrays with parameter names that are explicitly marked with `:list`:
@@ -467,6 +523,8 @@ export type StringifyOptions = {
 	/**
 	The character used to separate array elements when using `{arrayFormat: 'separator'}`.
 
+	A separator inside an element is percent-encoded, so `.parse()` can tell it apart from the separator between elements. With `comma` and `separator`, a plain value that contains the separator is percent-encoded the same way, so it does not turn into an array. Because of this, `%` and a hexadecimal digit are unsupported, since those also appear inside percent-encoded elements, and so are `&`, `+`, and `#`, since those already have a meaning in a URL: `&` separates parameters, `+` is decoded as a space, and `#` starts the fragment identifier. Those are handled on a best-effort basis, so the result is undefined. Whitespace cannot work at all, since leading and trailing whitespace is ignored when parsing, and a lone surrogate cannot be percent-encoded, so both throw a `TypeError`.
+
 	@default ,
 	*/
 	readonly arrayFormatSeparator?: string;
@@ -474,7 +532,7 @@ export type StringifyOptions = {
 	/**
 	Supports both `Function` as a custom sorting function or `false` to disable sorting.
 
-	If omitted, keys are sorted using `Array#sort`, which means, converting them to strings and comparing strings in Unicode code point order.
+	If omitted, keys are sorted using `Array#sort`.
 
 	@default true
 
@@ -498,7 +556,7 @@ export type StringifyOptions = {
 	//=> 'b=1&c=2&a=3'
 	```
 	*/
-	readonly sort?: ((itemLeft: string, itemRight: string) => number) | false;
+	readonly sort?: ((itemLeft: string, itemRight: string) => number) | boolean;
 
 	/**
 	Skip keys with `null` as the value.
@@ -556,7 +614,7 @@ export type StringifyOptions = {
 
 	Similar to the `replacer` parameter of `JSON.stringify()`, this function is called for each key-value pair and can be used to transform values before they are stringified.
 
-	The function receives the key and value, and should return the transformed value. Returning `undefined` will omit the key-value pair from the resulting query string.
+	The function receives the key and value, and should return the transformed value. Returning `undefined` will omit the key-value pair from the resulting query string. The `skipNull` and `skipEmptyString` options apply to the returned value.
 
 	This is useful for custom serialization of non-primitive types like `Date`:
 
@@ -602,13 +660,15 @@ Supported value types for query string parameters.
 
 Note: `Symbol`, functions, and objects (except arrays) are not supported and will throw an error when stringified.
 */
-export type Stringifiable = string | boolean | number | bigint | null | undefined; // eslint-disable-line @typescript-eslint/ban-types
+// `null` is a value `stringify()` accepts and `parse()` can produce, so it stays in the type.
+// eslint-disable-next-line @typescript-eslint/no-restricted-types
+export type Stringifiable = string | boolean | number | bigint | null | undefined;
 
 /**
 A record of stringifiable values.
 */
 export type StringifiableRecord = Record<
-string,
+	string,
 Stringifiable | readonly Stringifiable[]
 >;
 
@@ -632,7 +692,7 @@ export function stringify(
 	// Context: https://github.com/sindresorhus/query-string/issues/298
 	// object: StringifiableRecord,
 	object: Record<string, any>,
-	options?: StringifyOptions
+	options?: StringifyOptions,
 ): string;
 
 /**
@@ -649,15 +709,38 @@ queryString.extract('https://foo.bar?foo=bar');
 export function extract(url: string): string;
 
 export type UrlObject = {
+	/**
+	The URL to stringify. Leading and trailing whitespace is ignored.
+	*/
 	readonly url: string;
 
 	/**
 	Overrides queries in the `url` property.
 	*/
-	readonly query?: StringifiableRecord;
+	// TODO: Use the below instead when the following TS issues are fixed:
+	// - https://github.com/microsoft/TypeScript/issues/15300
+	// - https://github.com/microsoft/TypeScript/issues/42021
+	// Context: https://github.com/sindresorhus/query-string/issues/298
+	// readonly query?: StringifiableRecord;
+	readonly query?: Record<string, any>;
 
 	/**
 	Overrides the fragment identifier in the `url` property.
+
+	The fragment identifier without the leading `#`. An empty string removes the fragment identifier from the URL.
+
+	Like the query values, it is a decoded value and is percent-encoded when `encode` is `true`, so `.parseUrl()` reads it back unchanged. `/`, `?`, and `#` are kept as-is, so hash routes like `#/users?id=1` work. When `encode` is `false`, it is written as-is.
+
+	@example
+	```
+	import queryString from 'query-string';
+
+	queryString.stringifyUrl({url: 'https://foo.bar', fragmentIdentifier: '100%'});
+	//=> 'https://foo.bar#100%25'
+
+	queryString.stringifyUrl({url: 'https://foo.bar', fragmentIdentifier: '/users?id=1'});
+	//=> 'https://foo.bar#/users?id=1'
+	```
 	*/
 	readonly fragmentIdentifier?: string;
 };
@@ -669,7 +752,9 @@ The `options` are the same as for `.stringify()`.
 
 @returns A string with the URL and a query string.
 
-Query items in the `query` property overrides queries in the `url` property.
+Query items in the `query` property overrides queries in the `url` property. The query in the `url` property is written back from its plain string values, so `parseNumbers`, `parseBooleans`, and `types` do not rewrite it when the options are shared with `.parseUrl()`.
+
+With `encode: false`, an array marker in an existing parameter name is only treated as a marker when it is literal, such as `a[]`, so a percent-encoded marker such as `a%5B%5D` is not overridden by the plain key. The existing parameter is kept as-is, so overriding `a` alongside an existing `a%5B%5D` in the URL writes both `a=2&a%5B%5D=1`.
 
 The `fragmentIdentifier` property overrides the fragment identifier in the `url` property.
 
@@ -693,17 +778,19 @@ queryString.stringifyUrl({
 */
 export function stringifyUrl(
 	object: UrlObject,
-	options?: StringifyOptions
+	options?: StringifyOptions,
 ): string;
 
 /**
 Pick query parameters from a URL.
 
-@param url - The URL containing the query parameters to pick.
+@param url - The URL containing the query parameters to pick. Leading and trailing whitespace is ignored.
 @param keys - The names of the query parameters to keep. All other query parameters will be removed from the URL.
-@param filter - A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
+@param filter - A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers`, `parseBooleans`, and `types` options also affect `value`. They only affect the value passed to the filter. The query parameters are written back to the URL from the plain string values, so a value like `007` is not rewritten as `7`. The query is decoded only when `encode` is `true`, so a value like `a%20b` is not percent-encoded a second time. With `encode: false`, the filter receives the key and value as they are in the URL. The `decode` option is ignored. The stringify options apply to the output, so `skipNull` and `skipEmptyString` also drop a parameter that the filter kept.
 
-@returns The URL with the picked query parameters.
+@param options - The parse and stringify options, which also apply to the filter. `sort: false` keeps the original parameter order in the output.
+
+@returns The URL with the picked query parameters. The query parameters are sorted, like with `.stringify()`. Pass `sort: false` in the options to keep their order. With sorting disabled, integer-index keys come first in ascending numeric order, following JavaScript object enumeration. Repeated keys are grouped together.
 
 @example
 ```
@@ -717,32 +804,25 @@ queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value ===
 export function pick(
 	url: string,
 	keys: readonly string[],
-	options?: ParseOptions & StringifyOptions
+	options?: ParseOptions & StringifyOptions,
 ): string;
-export function pick(
-	url: string,
-	filter: (key: string, value: string | boolean | number) => boolean,
-	options?: {parseBooleans: true; parseNumbers: true} & ParseOptions & StringifyOptions
-): string;
-export function pick(
+export function pick<Options extends ParseOptions & StringifyOptions>(
 	url: string,
-	filter: (key: string, value: string | boolean) => boolean,
-	options?: {parseBooleans: true} & ParseOptions & StringifyOptions
-): string;
-export function pick(
-	url: string,
-	filter: (key: string, value: string | number) => boolean,
-	options?: {parseNumbers: true} & ParseOptions & StringifyOptions
+	// eslint-disable-next-line unicorn/consistent-boolean-name -- `filter` is a published parameter name.
+	filter: (key: string, value: ParsedQuery<ParsedValue<Options>>[string]) => boolean,
+	options?: KnownOptions<Options>,
 ): string;
 
 /**
 Exclude query parameters from a URL. Like `.pick()` but reversed.
 
-@param url - The URL containing the query parameters to exclude.
+@param url - The URL containing the query parameters to exclude. Leading and trailing whitespace is ignored.
 @param keys - The names of the query parameters to remove. All other query parameters will remain in the URL.
-@param filter - A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
+@param filter - A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers`, `parseBooleans`, and `types` options also affect `value`. They only affect the value passed to the filter. The query parameters are written back to the URL from the plain string values, so a value like `007` is not rewritten as `7`. The query is decoded only when `encode` is `true`, so a value like `a%20b` is not percent-encoded a second time. With `encode: false`, the filter receives the key and value as they are in the URL. The `decode` option is ignored. The stringify options apply to the output, so `skipNull` and `skipEmptyString` also drop a parameter that the filter kept.
+
+@param options - The parse and stringify options, which also apply to the filter. `sort: false` keeps the original parameter order in the output.
 
-@returns The URL without the excluded the query parameters.
+@returns The URL without the excluded query parameters. The query parameters are sorted, like with `.stringify()`. Pass `sort: false` in the options to keep their order. With sorting disabled, integer-index keys come first in ascending numeric order, following JavaScript object enumeration. Repeated keys are grouped together.
 
 @example
 ```
@@ -756,20 +836,13 @@ queryString.exclude('https://foo.bar?foo=1&bar=2#hello', (name, value) => value
 export function exclude(
 	url: string,
 	keys: readonly string[],
-	options?: ParseOptions & StringifyOptions
+	options?: ParseOptions & StringifyOptions,
 ): string;
-export function exclude(
-	url: string,
-	filter: (key: string, value: string | boolean | number) => boolean,
-	options?: {parseBooleans: true; parseNumbers: true} & ParseOptions & StringifyOptions
-): string;
-export function exclude(
+export function exclude<Options extends ParseOptions & StringifyOptions>(
 	url: string,
-	filter: (key: string, value: string | boolean) => boolean,
-	options?: {parseBooleans: true} & ParseOptions & StringifyOptions
-): string;
-export function exclude(
-	url: string,
-	filter: (key: string, value: string | number) => boolean,
-	options?: {parseNumbers: true} & ParseOptions & StringifyOptions
+	// eslint-disable-next-line unicorn/consistent-boolean-name -- `filter` is a published parameter name.
+	filter: (key: string, value: ParsedQuery<ParsedValue<Options>>[string]) => boolean,
+	options?: KnownOptions<Options>,
 ): string;
+
+export {}; // eslint-disable-line unicorn/require-module-specifiers -- It stops the implicit export of the declarations without `export`.