Object Query String

Stringify objects as URL Query Strings.

A lightweight mock of jQuery.param function without any dependencies!

Example

1// TypeScript
2import { queryString } from 'object-query-string';
3
4// Node.js
5const { queryString } = require("object-query-string");
6
7const query = queryString({
8    filter: {
9        brands: ["Audi"],
10        models: ["A4", "A6", "A8"],
11        accidentFree: true
12    },
13    sort: 'mileage'
14});
15

returns

filter[brands][]=Audi&filter[models][]=A4&filter[models][]=A6&filter[models][]=A8&filter[accidentFree]=true&sort=milage

Options

1// queryString(params : string, options : object|undefined)
2
3// default options
4queryString(params, {
5    separator: '&', // string 
6    encode: encodeURIComponent, // function(string) : string
7    encodeBrackets: false, // foo[baz]=1 or foo%5Bbaz%5D=1
8});
9

Inspired by jQuery's param!