Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
next-query-utils
Advanced tools
Readme
This library provides utility functions to deal with Parsed Query Objects (especially of Next.js)
このライブラリには、Parsed Query Object (特に Next.js のもの)を取り扱うためのユーティリティ関数群が含まれます。
// with npm
npm i next-query-utils
// with yarn
yarn add next-query-utils
?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")
?start_on=2022-03-02&item_type=stationary&item_type=book
-> ?start_on=2022-03-02&item_type=stationary
// 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
router.push(
removeQueryParam({
item_type: "book"
})(router.query)
)
/[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))
/items/[postId]
/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" })
This library is licensed under the terms of MIT License
FAQs
Provides functions to manipulate parsed url query object
The npm package next-query-utils receives a total of 153 weekly downloads. As such, next-query-utils popularity was classified as not popular.
We found that next-query-utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.