CyrefJS
CCyrefJS
EN
بازگشت به مستندات
URL/از نسخه 1.38.0

parseQuery

یک query string مربوط به URL را به یک Record شامل جفت‌های کلید و مقدار رشته‌ای تبدیل می‌کند.

parseQuery(query):Record<string, string>

نحوه عملکرد

تابع از query ارائه‌شده یک نمونه URLSearchParams ایجاد می‌کند. اگر query با ? شروع شود، این کاراکتر قبل از پردازش حذف می‌شود.

پردازش Query

هر entry از URLSearchParams به یک object از نوع Record<string, string> منتقل می‌شود.

کلیدهای تکراری

اگر یک کلید چند بار وجود داشته باشد، اختصاص دادن هر entry به object باعث می‌شود مقادیر بعدی، مقادیر قبلی همان کلید را جایگزین کنند.

کدگذاری URL

پردازش و decode کردن query مطابق رفتار native URLSearchParams انجام می‌شود.

Query خالی

یک query خالی یک object خالی برمی‌گرداند.

پارامترها

querystringالزامی

query string موردنظر برای پردازش. وجود علامت سؤال در ابتدای آن اختیاری است.

مقدار بازگشتی

Record<string, string>

یک شیء شامل پارامترهای پردازش‌شده query به‌صورت جفت‌های کلید و مقدار رشته‌ای برمی‌گرداند.

مثال‌ها

01

استفاده پایه

تبدیل یک query string به یک object.

TypeScript
import { parseQuery } from "@cyref/js";

parseQuery("page=2&limit=10");
// {
//   page: "2",
//   limit: "10"
// }
02

همراه با علامت سؤال

علامت سؤال ابتدایی قبل از پردازش به‌صورت خودکار حذف می‌شود.

TypeScript
parseQuery("?page=2&sort=latest");
// {
//   page: "2",
//   sort: "latest"
// }
03

مقادیر Encode شده

مقادیر مطابق رفتار URLSearchParams decode می‌شوند.

TypeScript
parseQuery("search=hello+world");
// {
//   search: "hello world"
// }
04

کلیدهای تکراری

اگر یک کلید چند بار تکرار شود، آخرین مقداری که برای آن کلید قرار می‌گیرد در object نهایی باقی می‌ماند.

TypeScript
parseQuery("tag=javascript&tag=typescript");
// {
//   tag: "typescript"
// }
ساخته شده با@cyref/js·مستندات رسمی