You can install package using yarn (or npm):
yarn add js-query-builder
Usage of this package is quite convenient.
Here is a simple example of query building:
;const url =;console;// /users?append=fullname%2Cranking&custom_param=value&fields%5Bcomments%5D=id%2Ccontent&fields%5Bposts%5D=id%2Cname&filter%5Bage%5D=20&include=posts%2Ccomments&page=1&sort=-created_at%2Cnameconsole;// /users?append=fullname,ranking&custom_param=value&fields[comments]=id,content&fields[posts]=id,name&filter[age]=20&include=posts,comments&page=1&sort=-created_at,name
This package does not provide ability to make requests because there is no need. You are not limited to any particular HTTP client. Use can use the one use want.
Here is an example with
;;const activeUsers = axios;
Let's imagine that you need to filter by username only if its length is more that 3 symbols.
Yeah, you can do it like this:
;const username = 'hi';const q = ;if usernamelength > 3q;const url = q;
But in such case it would be better to chain
;const username = 'hi';const url =;
Looks much more clear, does not it?
Sometimes you may want to tap the builder.
.tap() method is almost the same as
.when() but does not require condition.
;const url =;
You need to forget some filters, sorts, includes etc.?
Here you are:
;const url =;
Customizing parameter names
There may be cases when you need to customize parameter names.
You can define custom parameter names globally this way:
;// you may make such call is application bootstrapping fileQueryBuilder;const url =;// /users?p=5&s=name
yarn run test
Please see CONTRIBUTING for details.
Inspired by robsontenorio/vue-api-query.
The MIT License (MIT). Please see License File for more information.