A tiny (294B) browser utility for stringifying a query Object.
You should only consider using this within a browser context since Node's built-in querystring.stringify
is much faster and should be used in a Node environment! An ideal use case is serializing a query object before an API request is sent.
This module exposes three module definitions:
- ES Module:
dist/qss.mjs
- CommonJS:
dist/qss.js
- UMD:
dist/qss.min.js
$ npm install --save qss
import { encode, decode } from 'qss';
encode({ foo:'hello', bar:[1,2,3], baz:true });
//=> 'foo=hello&bar=1&bar=2&bar=3&baz=true'
encode({ foo:123 }, '?');
//=> '?foo=123'
encode({ bar:'world' }, 'foo=hello&');
//=> 'foo=hello&bar=world'
decode('foo=hello&bar=1&bar=2&bar=3&baz=true');
//=> { foo:'hello', bar:[1,2,3], baz:true };
Returns: String
Returns the formatted querystring.
Type: Object
The object that contains all query parameter keys & their values.
Type: String
Default: ''
An optional prefix. The stringified params
will be appended to this value, so it must end with your desired joiner; eg ?
.
Important: No checks or validations will run on your
prefix
. Similarly, no character is used to "glue" the query string to yourprefix
string.
Returns: Object
Returns an Object with decoded keys and values.
Repetitive keys will form an Array of its values. Also, qss
will attempt to typecast Boolean
and Number
values.
Type: String
The query string, without its leading ?
character.
qss.decode(
location.search.substring(1) // removes the "?"
);
Running Node v10.13.0
Encode
qss x 1,114,662 ops/sec ±0.23% (94 runs sampled)
native x 5,329,564 ops/sec ±0.56% (91 runs sampled)
query-string x 345,668 ops/sec ±1.18% (97 runs sampled)
querystringify x 922,295 ops/sec ±0.73% (93 runs sampled)
Decode
qss x 456,666 ops/sec ±0.86% (95 runs sampled)
native x 195,820 ops/sec ±0.47% (91 runs sampled)
query-string x 200,192 ops/sec ±0.25% (98 runs sampled)
querystringify x 301,697 ops/sec ±0.69% (96 runs sampled)
MIT © Luke Edwards