DefinitelyTyped/query-string/query-string.d.ts
Michael Klein 51fa4f7362 Allow stringifying any type of object
Previously was limited only to plain objects
2016-11-29 19:17:32 +01:00

31 lines
949 B
TypeScript

// Type definitions for query-string v3.0.0
// Project: https://github.com/sindresorhus/query-string
// Definitions by: Sam Verschueren <https://github.com/SamVerschueren>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare module "query-string" {
interface StringifyOptions { strict?: boolean; encode?: boolean; }
/**
* Parse a query string into an object.
* Leading ? or # are ignored, so you can pass location.search or location.hash directly.
* @param str
*/
export function parse(str: string): { [key: string]: string | string[] };
/**
* Stringify an object into a query string, sorting the keys.
*
* @param obj
*/
export function stringify(obj: any, options?: StringifyOptions): string;
/**
* Extract a query string from a URL that can be passed into .parse().
*
* @param str
*/
export function extract(str: string): string;
}