qs-like


> A tiny query string parsing and stringifying library.


Installation

$3

#### 1.x

``html


`

#### 2.x

`html




`

$3

`bash
npm install qs-like --save
`

`js
var append = require('qs-like/append');
var decode = require('qs-like/decode');
var encode = require('qs-like/encode');
var escape = require('qs-like/escape');
var parse = require('qs-like/parse');
var stringify = require('qs-like/stringify');
var unescape = require('qs-like/unescape');
`

`js
export {
append,
decode,
encode,
escape,
parse,
stringify,
unescape,
} from 'qs-like/es';
`

API

$3

- url a string URL to append to.
- query a string or object containing query params to append.
- options [object]
- encodeURIComponent [Function] The function to use when converting URL-unsafe characters to percent-encoding in the query string. Default: escape().
- decodeURIComponent [Function] The function to use when decoding percent-encoded characters in the query string. Default: unescape().
- filter [Function] The function to use when filtering query.

For example:

`js
append(null);
// ''

append('http://demo.com')
// 'http://demo.com'

append('http://demo.com', 123)
// 'http://demo.com'

append('http://demo.com', 'a=1&b=1&c=1')
// 'http://demo.com?a=1&b=1&c=1'

append('http://demo.com?test=1#hash', 'a=1&b=1&c=1')
// 'http://demo.com?test=1&a=1&b=1&c=1#hash'

append('http://demo.com', { a: 1, b: 1, c: 1 })
// 'http://demo.com?a=1&b=1&c=1'

append('http://demo.com?test=1#hash', { a: 1, b: 1, c: 1 })
// 'http://demo.com?test=1&a=1&b=1&c=1#hash'

append('http://demo.com', 'a=1&b=1&c=1&hideTopbar=1&hideSidebar=1', {
filter(key) {
return key !== 'hideTopbar' && key !== 'hideSidebar';
}
})
// 'http://demo.com?a=1&b=1&c=1'

append('http://demo.com', { a: 1, b: 1, c: 1, hideTopbar: 1, hideSidebar: 1 }, {
filter(key) {
return key !== 'hideTopbar' && key !== 'hideSidebar';
}
})
// 'http://demo.com?a=1&b=1&c=1'

`

$3

The decode() method is an alias for parse().

$3

The encode() method is an alias for stringify().

$3

The escape() method performs URL percent-encoding on the given str in a manner that is optimized for the specific requirements of URL query strings.

The escape() method is used by stringify() and is generally not expected to be used directly. It is exported primarily to allow application code to provide a replacement percent-encoding implementation if necessary by assigning escape() to an alternative function.

$3

- str The URL query string to parse.
- sep [string] The substring used to delimit key and value pairs in the query string. Default: '&'.
- eq [string] The substring used to delimit keys and values in the query string. Default: '='.
- options [object]
- decodeURIComponent [Function] The function to use when decoding percent-encoded characters in the query string. Default: unescape().

For example:

`js
parse(null)
// => {}

parse('12342343')
// => {}

parse('a=1&b=2&c=3&d=&f=')
// => { a: '1', b: '2', c: '3', d: '', f: '' }

parse('&a=1&b=2&c=3&d=&f=')
// => { a: '1', b: '2', c: '3', d: '', f: '' }

parse('abcd1234&a=1&b=2&c=3&d=&f=')
// => { a: '1', b: '2', c: '3', d: '', f: '' }

parse('?a=1&a=2&a=3&d=&f=')
// => { a: ['1', '2', '3'], d: '', f: '' }

parse('https://www.npmjs.com/search?q=qs#hash')
// => { q: 'qs' }

`

$3

- obj