Node’s querystring module implemented using the built-in URLSeachParams API.
npm install native-querystring[![Build Status][ci-img]][ci]
[![BrowserStack Status][browserstack-img]][browserstack]
Node’s querystring module implemented using the built-in [URLSeachParams
API][mdn].
:warning: Differences with original querystring module
- Space and its percent-encoded value (%20) is replaced with plus-sign +
- Fourth argument for parse and stringify is not supported
If you want to use Node’s url module based on the URL API, consider using
[native-url][native-url] module.
``sh`
npm install native-querystring --save
`js
import * as qs from 'querystring';
qs.parse('becky=1&jackson=brody&jackson=winnie'); // { becky: '1', jackson: ['brody', 'winnie'] }
qs.stringify({ becky: 1, gracie: ['rex', 'milo'], shadow: '' }); // becky=1&gracie=rex&gracie=milo&shadow=
`
If you want to alias querystring module to this module, refer to
[Webpack][webpack-alias] and [Rollup][rollup-alias] documentation on aliasing
modules (or, [native-url alias explanation][native-url-alias]).
Show me
Since native-url exposes ESM file through .mjs extension, additional Webpack configuration is needed to make native-url use ESM version of native-querystring.
`js`
{
module: {
rules: [
{
type: 'javascript/auto',
test: /\.mjs$/,
include: /node_modules\/native-url/,
resolve: {
mainFields: ['module']
},
use: []
}
];
}
}
Show me
native-querystring (and native-url) expose their methods thorugh named
exports. To get default behavior you would need to import entire module contents
`js
import * as qs from 'native-querystring'; // or 'querystring' if aliased
import * as url from 'native-url'; // or 'url' if aliased
This is fine for your own code, but dependencies will throw error since they
can’t find default export by default for both modules.
To fix this, it’s best to make changes to code at compile time to expose every
named export as property of object which should be default export.
Here is a Babel plugin code which achieves that:
`js
const babel = require('@babel/core');
const plugin = babel.createConfigItem(({ types: t }) => {
return {
visitor: {
ExportNamedDeclaration(path, parent) {
const properties = path.node.specifiers.map((node) => ({
exported: node.exported.name,
local: node.local.name
}));
path.insertAfter(
t.exportDefaultDeclaration(
t.objectExpression(
properties.map((prop) =>
t.objectProperty(
t.identifier(prop.exported),
t.identifier(prop.local)
)
)
)
)
);
}
}
};
});
`
And here is how you apply it with Webpack:
`js`
{
test: /\.m?js$/,
include: /node_modules\/(?:native-url|native-querystring)/,
use: [
{
loader: 'babel-loader',
options: {
plugins: [plugin]
}
}
]
};
After that you can use both modules’ named exports as default export.
Returns: Object
Parses a URL query string into a collection of key and value pairs.
| Property | Type | Default | Description |
| ----------- | -------- | ------- | ---------------------------------------------------------------------- |
| input | string | | The URL query string to parse. |separator
| | string | & | The substring used to delimit key and value pairs in the query string. |equals
| | string | = | The substring used to delimit keys and values in the query string. |
Returns: string
Produces a URL query string from a given obj by iterating through the object's
"own properties".
| Property | Type | Default | Description |
| ----------- | -------- | ------- | ---------------------------------------------------------------------- |
| input | Object | | The object to serialize into a URL query string. |separator
| | string | & | The substring used to delimit key and value pairs in the query string. |equals
| | string | = | The substring used to delimit keys and values in the query string. |
Returns: string
Performs URL percent-encoding on the given input in a manner that is optimized
for the specific requirements of URL query strings.
#### input
Type: string
Returns: string
Performs decoding of URL percent-encoded characters on the given input.
#### input
Type: string
Tested in IE9+ and all modern browsers.
It relies on the DOM [URLSearchParams API][mdn] to work. For older browsersURLSearchParams
that don’t support the API, a [polyfill][polyfill] is
available.
Test suite is taken from [Node core][node-tests] and [querystring-es3
module][querystring-es3-tests] to cover all native querystring test cases.
For automated tests, run npm run test:automated (append :watch` for watcher
support).
MIT © Ivan Nikolić
[ci]: https://travis-ci.com/niksy/native-querystring
[ci-img]: https://travis-ci.com/niksy/native-querystring.svg?branch=master
[browserstack]: https://www.browserstack.com/
[browserstack-img]: https://www.browserstack.com/automate/badge.svg?badge_key=a3dZR2xHRi9DSDJlVkZIVER6VXUzSUlsdndJQWpHZ1VOYjVBbEZBTHNqWT0tLW8zMEVSdjJ2OEg2TjdtM1NQV0F2c2c9PQ==--3f124646ce8289404c239e2264a39b18ca975418
[mdn]: https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams
[polyfill]: https://github.com/ungap/url-search-params
[native-url]: https://github.com/GoogleChromeLabs/native-url
[webpack-alias]: https://webpack.js.org/configuration/resolve/#resolvealias
[rollup-alias]: https://github.com/rollup/plugins/tree/master/packages/alias
[native-url-alias]: https://github.com/GoogleChromeLabs/native-url#usage
[node-tests]: https://github.com/nodejs/node/tree/v13.2.0/test/parallel
[querystring-es3-tests]: https://github.com/SpainTrain/querystring-es3/tree/master/test