alimortazavi-pr / next-app-use-query

Query controller for Next JS - App Directory

Query controller for Next JS - App Directory

Installation

npm install next-app-use-query

pnpm add next-app-use-query

yarn add next-app-use-query

Usage

import { useQuery } from "next-app-use-query";
import { useRouter } from "next/navigation";

const CheckQueryComponent = () => {
  const query = useQuery();
  const router = useRouter();

  function checkQueries() {
    //Get methods
    console.log(query.getAll()); // returns { search : 'Ali Mortazavi' , category: '1' } or {}
    console.log(query.getAll({ toQueryFormat: true })); // returns '?search=Ali+Mortazavi&category=1' or ''
    console.log(query.get("search")); // returns 'Ali Mortazavi' or ''

    //Set methods
    console.log(query.set({ search: "Ali Morazavi", category: "users" })); // returns '?search=Ali+Mortazavi&category=users'
    router.replace(
      "/users" + query.set({ search: "Ali Morazavi", category: "users" })
    );

    //Add methods
    //Add One
    console.log(query.add("rate", "5")); // returns '?search=Ali+Mortazavi&category=users&rate=5'
    router.replace("/users" + query.add("rate", "5"));
    //Add Many
    console.log(
      query.addMany({
        rate: "5",
        score: "10",
      })
    ); // returns '?search=Ali+Mortazavi&category=users&rate=5&score=10'
    router.replace(
      "/users" +
        query.addMany({
          rate: "5",
          score: "10",
        })
    );

    //Delete methods
    //Delete One
    console.log(query.delete("search")); // returns '?category=1&rate=5' or ''
    router.replace("/users" + query.delete("search"));
    //Delete Many
    console.log(query.deleteMany("search", "category")); // returns '?rate=5' or ''
    router.replace("/users" + query.deleteMany("search", "category"));
  }

  return (
    <div>
      <button onClick={checkQueries}>click me</button>
    </div>
  );
};

export default CheckQueryComponent;

Features

• Very fast
• Very easy