Fix the TypeScript types (sindresorhus#185)

Fixes sindresorhus#184
omgovich · Jun 20, 2019 · cba4c93 · cba4c93
1 parent f958329
commit cba4c93
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -89,8 +89,8 @@ export interface ParseOptions {
 	readonly parseBooleans?: boolean;
 }
 
-export interface ParsedQuery {
-	readonly [key: string]: string | number | boolean | Array<string | number | boolean> | null | undefined;
+export interface ParsedQuery<T = string> {
+	[key: string]: T | T[] | null | undefined;
 }
 
 /**
@@ -100,6 +100,9 @@ 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 interface ParsedUrl {

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -51,12 +51,15 @@ expectType<queryString.ParsedQuery>(
 expectType<queryString.ParsedQuery>(
 	queryString.parse('?foo=bar', {arrayFormat: 'comma'})
 );
-expectType<queryString.ParsedQuery>(
+expectType<queryString.ParsedQuery<string | number>>(
 	queryString.parse('?foo=1', {parseNumbers: true})
 );
-expectType<queryString.ParsedQuery>(
+expectType<queryString.ParsedQuery<string | boolean>>(
 	queryString.parse('?foo=true', {parseBooleans: true})
 );
+expectType<queryString.ParsedQuery<string | boolean | number>>(
+	queryString.parse('?foo=true', {parseBooleans: true, parseNumbers: true})
+);
 
 // Parse URL
 expectType<queryString.ParsedUrl>(queryString.parseUrl('?foo=bar'));