DefinitelyTyped/types/query-string/index.d.ts

// Type definitions for query-string 6.2
// Project: https://github.com/sindresorhus/query-string
// Definitions by: Sam Verschueren <https://github.com/SamVerschueren>
//                 Tanguy Krotoff <https://github.com/tkrotoff>
//                 HuHuanming <https://github.com/huhuanming>
//                 Madara Uchiha <https://github.com/MadaraUchiha>
//                 Josh Holmer <https://github.com/shssoichiro>
//                 Simon Van den Broeck <https://github.com/jarrku>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.2

export interface ParseOptions {
    arrayFormat?: 'bracket' | 'index' | 'none';
    decode?: boolean;
}

export interface InputParams {
  [key: string]: any;
}

export interface OutputParams {
  [key: string]: string | string[] | undefined;
}

/**
 * Parse a query string into an object.
 * Leading ? or # are ignored, so you can pass location.search or location.hash directly.
 */
export function parse(str: string, options?: ParseOptions): OutputParams;

export function parseUrl(str: string, options?: ParseOptions): {url: string, query: OutputParams};

export interface StringifyOptions {
    strict?: boolean;
    encode?: boolean;
    arrayFormat?: 'bracket' | 'index' | 'none';
    sort?: ((m: string, n: string) => boolean) | boolean;
}

/**
 * Stringify an object into a query string, sorting the keys.
 */
export function stringify(obj: InputParams, options?: StringifyOptions): string;

/**
 * Extract a query string from a URL that can be passed into .parse().
 */
export function extract(str: string): string;