nested-query-params/README.md

Rack like parsing of nested query parameters

<header align="center">
  <p align="center"><img align="center" src="./logo.svg" width="200px"/></p>
  <h3 align="center">Nested Query Params</h3>
  <p align="center">A TypeScript implementation of Rack's query string parser.</p>
</header>

## Overview

<p align="center">
  <img src="./example.svg" width="640px"/>
</p>

A TypeScript implementation of Rack's [query string parser]. Allows query strings to be expanded into "structural" types; objects, arrays, and string values are supported.

## Installation

```shell
npm i -D nested-query-params
```

## Usage

```typescript
import { parseQuery, printQuery } from "nested-query-params";

// maps
const map = parseQuery("?foo[bar]=baz");
console.debug(map.foo.bar); // prints "baz"

// arrays
const list = parseQuery("?foo[]=bar&foo[]=baz");
console.debug(list.foo); // prints ["bar", "baz"]

// mixed
const mixed = parseQuery("?bar=baz&foo[bar][]=baz&foo[bar][]=42");
console.debug(mixed); // prints { bar: "baz", foo: { bar: ["baz", "42"] } }

// print
const simple = parseQuery("?foo[bar]=baz");
console.debug(printQuery(simple)); // prints "?foo[bar]=baz"

// print valid
const edited = { ...simple, foo: "bar" };
console.debug(printQuery(edited)); // prints "?foo=bar"
```

[query string parser]: https://github.com/rack/rack/blob/bad8fe37c8867596855dcd0b3fe3030acc6b8621/lib/rack/query_parser.rb#L63