1.38.0getQueryParam
مقدار یک پارامتر query را از یک URL یا query string دریافت می‌کند.
getQueryParam(url, key):string | nullنحوه عملکرد
تابع اولین علامت سؤال موجود در ورودی را پیدا می‌کند. اگر وجود داشته باشد، تمام متن بعد از آن به‌عنوان query string در نظر گرفته می‌شود. اگر علامت سؤال وجود نداشته باشد، کل ورودی به‌عنوان query string استفاده می‌شود.
Query خالی
اگر query string استخراج‌شده خالی باشد، تابع بلافاصله null برمی‌گرداند و نمونه‌ای از URLSearchParams ایجاد نمی‌کند.
URLSearchParams
query string با استفاده از URLSearchParams پردازش می‌شود و کلید موردنظر با get() دریافت می‌شود. بنابراین decode کردن و پردازش پارامترها مطابق رفتار native URLSearchParams انجام می‌شود.
مقدار بازگشتی
تابع مقدار پارامتر را به‌صورت string برمی‌گرداند و اگر کلید موردنظر وجود نداشته باشد null برمی‌گرداند.
پارامترها
urlstringالزامیURL یا query string شامل پارامتر موردنظر.
keystringالزامینام پارامتر query که باید دریافت شود.
مقدار بازگشتی
string | nullاگر کلید موردنظر وجود داشته باشد مقدار آن را برمی‌گرداند و در غیر این صورت null برمی‌گرداند.
مثال‌ها
استفاده پایه
دریافت یک پارامتر query از یک URL کامل.
import { getQueryParam } from "@cyref/js";
getQueryParam(
"https://example.com/products?page=2&limit=10",
"page",
);
// "2"
getQueryParam(
"https://example.com/products?page=2&limit=10",
"limit",
);
// "10"پارامتر موجود نیست
اگر پارامتر موردنظر وجود نداشته باشد null برمی‌گرداند.
getQueryParam(
"https://example.com/products?page=2",
"sort",
);
// nullورودی Query String
این تابع می‌تواند یک query string را نیز مستقیماً دریافت کند.
getQueryParam("page=2&sort=latest", "page");
// "2"
getQueryParam("page=2&sort=latest", "sort");
// "latest"مقادیر Encode شده
مقادیر پارامترها مطابق رفتار URLSearchParams decode می‌شوند.
getQueryParam(
"https://example.com/search?q=hello+world",
"q",
);
// "hello world"