@vortechron/query-builder-ts

JavaScript/TypeScript Query Builder provides a way to build a query string compatible with spatie/laravel-query-builder.

Install

You can install package using yarn (or npm):

yarn add @vortechron/query-builder-ts

Usage

Usage of this package is quite EZ.

All Example

Here is a simple example:

import { query } from "@vortechron/query-builder-ts";

const nameSortScope = (q) => q.sort("name");

const theQuery = query("/users")
	.filter("age", 20)
	.sort("-created_at")
	.scopes(nameSortScope)
	.include("posts", "comments")
	.append("fullname", "ranking")
	.fields({
		posts: ["id", "name"],
		comments: ["id", "content"],
	})
	.param("custom_param", "value")
	.page(1);

console.log(theQuery.build());
// /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%2Cname

console.log(decodeURIComponent(theQuery.build()));
// /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

// usefull when using with framework like tanstack/query for query keys
console.log(theQuery.buildAsArray());
// ["filter[age]=20", "sort=-created_at,name", "include=posts,comments", "append=fullname,ranking", "fields[posts]=id,name", "fields[comments]=id,content", "custom_param=value"]

console.log(
	theQuery.buildAsArray({
		includePath: true,
		includePagination: true,
		excludes: ["page", "sort"],
	})
);
// ["/users", "filter[age]=20", "include=posts,comments", "append=fullname,ranking", "fields[posts]=id,name", "fields[comments]=id,content", "custom_param=value", "page=1"]

Making requests

Here is an example with axios:

import axios from "axios";
import { query } from "@vortechron/query-builder-ts";

const activeUsers = axios.get(
	query("/users").filter("status", "active").sort("-id").page(1).build()
);

Conditions

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 "@vortechron/query-builder-ts";

const username = "hi";

const q = query("/users");

if (username.length > 3) {
	q.filter("name", username);
}

const url = q.build();

But in such case it would be better to chain .when() method:

import { query } from "@vortechron/query-builder-ts";

const username = "hi";

const url = query("/users")
	.when(username.length > 3, (q) => q.filter("name", username))
	.build();

Looks much more clear, does not it?

Tapping

Sometimes you may want to tap the builder. .tap() method is almost the same as .when() but does not require condition.

import { query } from "@vortechron/query-builder-ts";

const url = query("/users")
	.sort("id")
	.tap((q) => {
		console.log(q.build());
	})
	.include("comments")
	.build();

Forgetting

You need to forget some filters, sorts, includes etc.?

Here you are:

import { query } from "@vortechron/query-builder-ts";

const url = query("/users")
	.include("comments", "posts")
	.sort("name")
	.forget("include", "comments")
	.build();

Customizing parameter names

There may be cases when you need to customize parameter names.

You can define custom parameter names globally this way:

import { query, QueryBuilder } from "@vortechron/query-builder-ts";

// you may make such call is application bootstrapping file
QueryBuilder.defineAliases({
	page: "p",
	sort: "s",
});

const url = query("/users")
	.sort("name")
	.page(5)
	.tap((q) => console.log(decodeURIComponent(q.build())));

// /users?p=5&s=name

Testing

yarn run test

Contributing

Please see CONTRIBUTING for details.

Credits

Inspired by coderello/js-query-builder.

License

The MIT License (MIT). Please see License File for more information.