Skip to content

Fix the TypeScript types #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 20, 2019
Merged

Fix the TypeScript types #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
10ed7ba
Fix types.
cdeutsch Jun 19, 2019
021feb3
Update index.d.ts
sindresorhus Jun 20, 2019
1baf0fe
Update index.d.ts
sindresorhus Jun 20, 2019
d2624f2
Make `ParsedQuery` accept generic types instead of having 4 different…
cdeutsch Jun 20, 2019
018abb3
Update index.d.ts
sindresorhus Jun 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

/**
Expand All @@ -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 {
Expand Down
7 changes: 5 additions & 2 deletions index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'));
Expand Down