Format url with query (string or object), simple and fast, with the power of qs.

The typical usage of this library is building URL for Fetch API. It can be used both on server side and browser side.

1const withQuery = require('with-query').default;
2
3fetch(withQuery('https://api.github.com/search/repositories', {
4  q: 'query',
5  sort: 'stars',
6  order: 'asc',
7}))
8.then(res => res.json())
9.then((json) => {
10  console.info(json);
11})
12.catch((err) => {
13  console.error(err);
14});

Installation

• npm

1npm install with-query --save

• yarn

1yarn add with-query

Usage

1var withQuery = require('with-query').default;
2var assert = require('assert');
3
4const result1 = withQuery('http://example.com', {
5  a: 1,
6  b: 'hello',
7});
8assert.equal(result1, 'http://example.com?a=1&b=hello');
9
10// Append and override the query in url
11const result2 = withQuery('http://example.com?a=3&c=4&d=5', {
12  a: 1,
13  b: 'hello',
14});
15assert.equal(result2, 'http://example.com?a=1&c=4&d=5&b=hello');
16
17// Hash is also supported
18const result3 = withQuery('http://example.com?a=3&c=4&d=5#Append', {
19  a: 1,
20  b: 'hello',
21});
22assert.equal(result3, 'http://example.com?a=1&c=4&d=5&b=hello#Append');
23
24// Remove hash
25const result4 = withQuery('http://example.com?a=3&c=4&d=5#Append', {
26  a: 1,
27  b: 'hello',
28}, { noHash: true });
29assert.equal(result4, 'http://example.com?a=1&c=4&d=5&b=hello');
30
31// with the power of qs
32const result5 = withQuery('http://example.com?e[]=f', {
33  a: {
34    b: 'c',
35  },
36});
37assert.equal(result5, 'http://example.com?e%5B0%5D=f&a%5Bb%5D=c');
38
39// parseOpt and stringifyOpt for qs.parse and qs.stringify
40// see https://github.com/ljharb/qs
41const result6 = withQuery('http://example.com&e[]=f', {
42  a: {
43    b: 'c',
44  },
45}, {
46  stringifyOpt: {
47    encode: false,
48  },
49  parseOpt: {
50    parseArray: false,
51  },
52});
53assert.equal(result6, 'http://example.com&e[]=f?a[b]=c');

License

MIT