Next Query Utils

Note

This lib no longer updates in npm. latest:

Instead, use JSR where it's published as v2.x or later

This library provides utility functions to deal with Parsed Query Objects (especially of Next.js)

このライブラリには、Parsed Query Object （特に Next.js のもの）を取り扱うためのユーティリティ関数群が含まれます。

Migration from v1 to v2

As the only difference; v2 is provided as @honey32/next-query-utils via JSR, while v1 as next-query-utils via npm.

When you try to migrate from npm to JSR, see: https://jsr.io/docs/npm-compatibility

Usages — 使い方

Getting single value — 単独の値を取得する

?id=aaa or ?id=aaa&id=other -> "aaa"

// before
const _id = router.query["id"];
const id = Array.isArray(id) ? id[0] : id;

// after
const id = getSingleQueryParam(router.query, "id");

Removing some params — 値を取り除く

?start_on=2022-03-02&item_type=stationary&item_type=book -> ?start_on=2022-03-02&item_type=stationary

Before

Code (I don't want to write such an annoying code any more.)
二度と書きたくないひどいコード

// before
const removeQuery = (
  query: ParsedUrlQuery,
  key: string,
  pred: string,
) => {
  const value = query[key];

  // if empty, leave query as it is.
  if (!value) return query;
  if (Array.isArray(value)) {
    if (value.length === 0) return query;

    // if non-empty array of string
    return { ...acc, [key]: value.filter((s) => s !== pred) };
  }

  // if single string (not empty)
  return { ...acc, [key]: (s !== value) ? value : [] };
};

After

// after
router.push(
  removeQueryParam({
    item_type: "book",
  })(router.query),
);

Keeping some params (or Next.js's dynamic routes) from being reset
— （Next.js's の動的ルートや）パラメータを残して他を削除する

/[postId]?other=value&other2=value -> /[postId]

---

In pages with Next.js's dynamic routes, router.query include them (in this example, .postId). so they MUST be kept from resetting.

In this case, use resetQuery() with ignore option.

---

Next.js の動的ルートがあるページでは、それが router.query に含まれる。（この例では .postId） なので、それらは 削除してはいけない。

このようなケースでは resetQuery() と ignore オプションを使いましょう。

---

// before
router.push({ postId: router.query["postId"] });

// after
router.push(resetQuery({ ignore: "postId" })(router.query));

Checking if query is empty ignoring some params (e.g. dynamic routes)
— （動的ルートのような）パラメータ幾つかを無視して、クエリが空であるか確かめる

• True if /items/[postId]
• False if /items/[postId]?param1=aa

---

Likewise, you need to ignore dynamic routes in order to check if the query is empty.

In this case, use isQueryEmpty() with ignore option.

---

前の例と同じように、クエリが空であるか確かめるためには、 動的ルート を無視する必要があります。

このようなケースでは、isQueryEmpty() と ignore オプションを使いましょう。

---

isQueryEmpty(router.query, { ignore: "postId" });

License

This library is licensed under the terms of MIT License