Matthew C.
—You have a URL with GET parameters, which are known as query string parameters. For example, your query string may have a type, page, and sort parameter:
https://www.example.com/store?type=sale&sort=price_descending&page=43
The query string part of the URL starts with a ”?” character. Each parameter is separated by a ”&” character. How do you get these query parameter values using JavaScript?
You can get the query string parameters in the browser using JavaScript and Web APIs. You can also get query string parameters on the backend using Node.js.
You can use the URLSearchParams
interface Web API to work with URL query strings. The URLSearchParams()
constructor takes in a query string as an argument and returns a URLSearchParams
object that has methods to work with query strings. You can use the window.location.search
property to access the query string of the current page and pass it as an argument to the URLSearchParams()
constructor:
const searchParams = new URLSearchParams(window.location.search);
To check if a query parameter exists you can use the has()
method, which returns a boolean indicating if a parameter exists:
console.log(searchParams.has("sort")); // true
You can get the value of the query parameter using the get()
method:
console.log(searchParams.get("sort")); // price_descending
The get()
method returns the first value found for the given query parameter. So if there is a duplicate query parameter, only the value of the first one will be returned. You can use the getAll()
method to return all values for a given query parameter.
You can loop through query parameters using various methods such as
for...of
:
for (const param of searchParams) { console.log(param); }
Using the example URL above, https://www.example.com/store?type=sale&sort=price_descending&page=43
, this loop will return the following arrays with the keys and values of the parameters:
["type", "sale"] ["sort", "price_descending"] ["page", "43"]
You can also use the following methods to loop through the query parameters:
One thing to note is that the URLSearchParams()
constructor interprets plus signs (”+”) as spaces, which can be an issue in certain cases. You can avoid this issue by encoding the URL string using the encodeURIComponent()
function. This will change the ”+” character to the UTF-8 encoding of the character, which is %2B
.
If you are using Express.js, which is a popular web framework for Node.js, you can use the req.query
object to get query strings:
app.get("/", (req, res) => { console.log(req.query); });
If there are no query string parameters, req.query
will return an empty object. If there are query parameters, an object containing each parameter and its value will be returned:
app.get("/", (req, res) => { console.log(req.query); // { type: "sale ", sort: "price_descending ", page: "43" } });
You can use a for...in
loop to loop through the query parameters object to get the query parameter values:
for (const key in req.query) { console.log(key, req.query[key]); }
Using the example URL https://www.example.com/store?type=sale&sort=price_descending&page=43
, this loop will log the following strings:
type sale sort price_descending page 43
Other methods can also be used to loop through the query parameters object:
Tasty treats for web developers brought to you by Sentry. Get tips and tricks from Wes Bos and Scott Tolinski.
SEE EPISODESConsidered “not bad” by 4 million developers and more than 100,000 organizations worldwide, Sentry provides code-level observability to many of the world’s best-known companies like Disney, Peloton, Cloudflare, Eventbrite, Slack, Supercell, and Rockstar Games. Each month we process billions of exceptions from the most popular products on the internet.
Here’s a quick look at how Sentry handles your personal information (PII).
×We collect PII about people browsing our website, users of the Sentry service, prospective customers, and people who otherwise interact with us.
What if my PII is included in data sent to Sentry by a Sentry customer (e.g., someone using Sentry to monitor their app)? In this case you have to contact the Sentry customer (e.g., the maker of the app). We do not control the data that is sent to us through the Sentry service for the purposes of application monitoring.
Am I included?We may disclose your PII to the following type of recipients:
You may have the following rights related to your PII:
If you have any questions or concerns about your privacy at Sentry, please email us at compliance@sentry.io.
If you are a California resident, see our Supplemental notice.