1.38.0buildQuery
یک query string برای URL از یک Record شامل جفت‌های کلید و مقدار رشته‌ای می‌سازد.
buildQuery(params):stringنحوه عملکرد
این تابع از Record ارائه‌شده یک نمونه URLSearchParams می‌سازد و سپس با استفاده از toString() نسخه‌ی رشته‌ای و serializeشده‌ی آن را برمی‌گرداند.
کدگذاری URL
نام پارامترها و مقادیر مطابق رفتار URLSearchParams serialize می‌شوند و کاراکترهای خاص نیز طبق قوانین آن URL encode می‌شوند.
فرمت Query String
رشته‌ی برگشتی شامل جفت‌های کلید و مقدار است که با & از هم جدا می‌شوند و علامت سؤال ابتدایی ندارد.
پارامترها
paramsRecord<string, string>الزامیشیئی شامل کلیدها و مقادیر رشته‌ای که باید به پارامترهای query در URL تبدیل شوند.
مقدار بازگشتی
stringرشته‌ی query کدگذاری‌شده را بدون علامت سؤال ابتدایی برمی‌گرداند.
مثال‌ها
استفاده پایه
ساخت یک query string از جفت‌های کلید و مقدار.
import { buildQuery } from "@cyref/js";
buildQuery({
page: "2",
limit: "10",
});
// "page=2&limit=10"کدگذاری URL
کاراکترهای خاص و فاصله‌ها مطابق رفتار URLSearchParams کدگذاری می‌شوند.
buildQuery({
search: "hello world",
category: "web development",
});
// "search=hello+world&category=web+development"استفاده از نتیجه در URL
می‌توان query string برگشتی را با استفاده از علامت سؤال به URL اضافه کرد.
const query = buildQuery({
page: "1",
sort: "latest",
});
const url = `https://example.com/posts?${query}`;
// "https://example.com/posts?page=1&sort=latest"