object-query-string
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

Object Query String

Stringify objects as URL Query Strings.

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

Example

// TypeScript
import { queryString } from 'object-query-string';

// Node.js
const { queryString } = require("object-query-string");

const query = queryString({
    filter: {
        brands: ["Audi"],
        models: ["A4", "A6", "A8"],
        accidentFree: true
    },
    sort: 'mileage'
});

returns

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

Options

// queryString(params : string, options : object|undefined)

// default options
queryString(params, {
    separator: '&', // string 
    encode: encodeURIComponent, // function(string) : string
    encodeBrackets: false, // foo[baz]=1 or foo%5Bbaz%5D=1
});

Inspired by jQuery's param!

Dependencies (0)

    Dev Dependencies (4)

    Package Sidebar

    Install

    npm i object-query-string

    Weekly Downloads

    8,349

    Version

    1.2.0

    License

    ISC

    Unpacked Size

    16 kB

    Total Files

    11

    Last publish

    Collaborators

    • deltazero