# @types/query-string-params

> TypeScript definitions for query-string-params

Latest version **1.7.2** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/query-string-params
pnpm add @types/query-string-params
yarn add @types/query-string-params
bun add @types/query-string-params
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.7.2 |
| Published | 2023-11-07 |
| First published | 2020-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51443 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/query-string-params
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/query-string-params
- npm.io page: https://npm.io/package/@types/query-string-params

## Recent versions

- 1.7.2 (latest) — 2023-11-07
- 1.7.0 (ts3.0) — 2020-07-28
- 1.7.1 — 2023-10-18

## README

# Installation
> `npm install --save @types/query-string-params`

# Summary
This package contains type definitions for query-string-params (https://github.com/bansalrachita/query-string-params#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/query-string-params.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/query-string-params/index.d.ts)
````ts
/**
 * Transforms complex object in a URL search string.
 * For e.g. {orgType: ["a", "b", "c"], orgId: ["x ", "y"]} -> "orgType=a,b,c&orgId=x,y"
 */
export function propertyToUrl(obj: SearchParamOptions): string;

/**
 * Transforms a URL search string to an object.
 * For e.g. "?foo=xyz&bar=abc" -> {{foo: [xyz]}, {bar: [abc]}}
 */
export function urlToProperty(url: string): SearchParamOptions;

/**
 * Transforms a URL search string to an object.
 * For e.g. "?foo=xyz&bar=abc" -> [{foo: [xyz]}, {bar: [abc]}]
 */
export function urlToList(url: string): SearchParamOptions[];

/**
 * Search params options.
 * Can be in the form of key value pair where
 * the key is a string and value is an array of strings.
 */
export interface SearchParamOptions {
    [name: string]: string[];
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Rachita](https://github.com/bansalrachita).

---
_Source: https://npm.io/package/@types/query-string-params · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._