- Notifications
You must be signed in to change notification settings - Fork6
🧱 An easy way to build a query string compatible with "spatie/laravel-query-builder".
License
coderello/js-query-builder
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
JavaScript Query Builder provides an easy way to build a query string compatible withspatie/laravel-query-builder.
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:
import{query}from'js-query-builder';consturl=query('/users').filter('age',20).sort('-created_at','name').include('posts','comments').append('fullname','ranking').fields({posts:['id','name'],comments:['id','content'],}).param('custom_param','value').page(1).build();console.log(url);// /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.log(decodeURIComponent(url));// /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 withaxios:
importaxiosfrom'axios';import{query}from'js-query-builder';constactiveUsers=axios.get(query('/users').filter('status','active').sort('-id').page(1).build());
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:
import{query}from'js-query-builder';constusername='hi';constq=query('/users');if(username.length>3){q.filter('name',username);}consturl=q.build();
But in such case it would be better to chain.when() method:
import{query}from'js-query-builder';constusername='hi';consturl=query('/users').when(username.length>3,q=>q.filter('name',username)).build();
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.
import{query}from'js-query-builder';consturl=query('/users').sort('id').tap(q=>{console.log(q.build());}).include('comments').build();
You need to forget some filters, sorts, includes etc.?
Here you are:
import{query}from'js-query-builder';consturl=query('/users').include('comments','posts').sort('name').forgetInclude('comments').build();
There may be cases when you need to customize parameter names.
You can define custom parameter names globally this way:
import{query,QueryBuilder}from'js-query-builder';// you may make such call is application bootstrapping fileQueryBuilder.defineCustomParameterNames({page:'p',sort:'s',});consturl=query('/users').sort('name').page(5).tap(q=>console.log(decodeURIComponent(q.build())));// /users?p=5&s=name
yarn runtestPlease seeCONTRIBUTING for details.
Inspired byrobsontenorio/vue-api-query.
The MIT License (MIT). Please seeLicense File for more information.
About
🧱 An easy way to build a query string compatible with "spatie/laravel-query-builder".
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Uh oh!
There was an error while loading.Please reload this page.