query-string
Parse and stringify URL query strings
🔥 Want to strengthen your core JavaScript skills and master ES6?
I would personally recommend this awesome ES6 course by Wes Bos.
Also check out his Node.js, React, Sublime courses.
Install
$ npm install query-string
This module targets Node.js 6 or later and the latest version of Chrome, Firefox, and Safari. If you want support for older browsers, use version 5: npm install query-string@5
.
Usage
const queryString = ; console;//=> '?foo=bar' const parsed = queryString;console;//=> {foo: 'bar'} console;//=> '#token=bada55cafe' const parsedHash = queryString;console;//=> {token: 'bada55cafe'} parsedfoo = 'unicorn';parsedilike = 'pizza'; const stringified = queryString;//=> 'foo=unicorn&ilike=pizza' locationsearch = stringified;// note that `location.search` automatically prepends a question markconsole;//=> '?foo=unicorn&ilike=pizza'
API
.parse(string, [options])
Parse a query string into an object. Leading ?
or #
are ignored, so you can pass location.search
or location.hash
directly.
The returned object is created with Object.create(null)
and thus does not have a prototype
.
URI components are decoded with decode-uri-component
.
arrayFormat
Type: string
Default: 'none'
Supports both index
for an indexed array representation or bracket
for a bracketed array representation.
bracket
: stands for parsing correctly arrays with bracket representation on the query string, such as:
queryString;//=> foo: [1,2,3]
index
: stands for parsing taking the index into account, such as:
queryString;//=> foo: [1,2,3]
none
: is the default option and removes any bracket representation, such as:
queryString;//=> foo: [1,2,3]
.stringify(object, [options])
Stringify an object into a query string, sorting the keys.
strict
Type: boolean
Default: true
Strictly encode URI components with strict-uri-encode. It uses encodeURIComponent if set to false. You probably don't care about this option.
encode
Type: boolean
Default: true
URL encode the keys and values.
arrayFormat
Type: string
Default: 'none'
Supports both index
for an indexed array representation or bracket
for a bracketed array representation.
bracket
: stands for parsing correctly arrays with bracket representation on the query string, such as:
queryString;// => foo[]=1&foo[]=2&foo[]=3
index
: stands for parsing taking the index into account, such as:
queryString;// => foo[0]=1&foo[1]=2&foo[3]=3
none
: is the default option and removes any bracket representation, such as:
queryString;// => foo=1&foo=2&foo=3
sort
Type: Function
boolean
Supports both Function
as a custom sorting function or false
to disable sorting.
const order = 'c' 'a' 'b';queryString;// => 'c=3&a=1&b=2'
queryString;// => 'c=3&a=1&b=2'
If omitted, keys are sorted using Array#sort
, which means, converting them to strings and comparing strings in Unicode code point order.
.extract(string)
Extract a query string from a URL that can be passed into .parse()
.
.parseUrl(string, [options])
Extract the URL and the query string as an object.
The options
are the same as for .parse()
.
Returns an object with a url
and query
property.
queryString;//=> {url: 'https://foo.bar', query: {foo: 'bar'}}
Nesting
This module intentionally doesn't support nesting as it's not spec'd and varies between implementations, which causes a lot of edge cases.
You're much better off just converting the object to a JSON string:
queryString;//=> 'foo=bar&nested=%7B%22unicorn%22%3A%22cake%22%7D'
However, there is support for multiple instances of the same key:
queryString;//=> {likes: ['cake', 'icecream'], name: 'bob'} queryString;//=> 'color=chartreuse&color=taupe&id=515'
Falsy values
Sometimes you want to unset a key, or maybe just make it present without assigning a value to it. Here is how falsy values are stringified:
queryString;//=> 'foo=false' queryString;//=> 'foo' queryString;//=> ''
License
MIT © Sindre Sorhus