TIL: URLSearchParams

Modified June 24, 2024

Tim Deschryver

timdeschryver.dev

It has been a while that I had the need to read and write query parameters from an URL myself because Angular abstracts all of this away in the @angular/router package. But because my personal blog is written with Svelte and I wanted to have a feature to search for blog posts, I had to write it myself this time.

From my experience with query strings, during the jQuery era, this wasn't straight forward. But today I learned about the URLSearchParams API and now it is super easy!

Let's take a look at an example.

We have the URL https://timdeschryver.dev/blog?q=Angular+NgRx and we want want to retrieve the query params to filter blog posts based on the q parameter.

To create the URLSearchParams we need to access the query string, this is available on the search property of the location. With it, we can create a new instance of URLSearchParams.

 content_paste
console.log(location.search);
// |> '?q=Angular+NgRx'
const params = new URLSearchParams(location.search);

While writing this blog post, I also discovered that the search params are available on URL instances and on anchor tags (<a>).

 content_paste
const url = new URL(location.search);
const params = url.searchParams;
 
const node = document.querySelector('#search');
const url = new URL(node.href);
const params = new URLSearchParams(node.search);

So now that we have params, what can we do with it?

We can read a query parameter with the get method.

 content_paste
params.get('q');
// |> 'Angular NgRx'

We can set a query parameter with the set method.

 content_paste
params.set('q', 'Performance');

We can delete a query parameter with the delete method.

 content_paste
params.delete('q');

So easy! We don't have to manually parse the query parameters ourselves and we're sure that it's bug-free. There are even not all the available methods, these are just the ones I used and I think are the ones that are used the most.

Navigating link

Setting and deleting the search params doesn't change the current location. To modify the current location we can make use of the history.replaceState method and pass it the new URL.

The stringified version of params will concatenate all keys and values to one query string.

 content_paste
console.log(params.toString());
// |> q=Testing+Library

Together with the current pathname, we can create a new URL.

 content_paste
window.history.replaceState(window.history.state, '', `${location.pathname}?${params}`);

Example code link

I ended up with the following code to set a new URL and to filter the blog posts. Using the svelte reactive statements it's simple to react to value changes and makes the whole flow easy to read.

 content_paste
// instantiate with the query parameter
// query is bound to an input element (<input bind:value={query} type="search"  />)
let query = $page.query['q'] || '';
 
// change the URL when the query is changed
$: if (typeof window !== 'undefined') {
  let params = new URLSearchParams(window.location.search);
 
  if (query) {
    params.set('q', query);
    window.history.replaceState(window.history.state, '', `${location.pathname}?${params}`);
  } else {
    params.delete('q');
    window.history.replaceState(window.history.state, '', location.pathname);
  }
}
 
// filter posts based on the query
$: if (query) {
  filteredPosts = posts.filter((p) => {
    return queryParts.every(
      (q) =>
        p.metadata.tags.some((t) => match(t, q)) ||
        like(p.metadata.title, q) ||
        like(p.metadata.description, q),
    );
  });
} else {
  filteredPosts = posts;
}

Additional resources link

• URLSearchParams MDN web docs
• Easy URL Manipulation with URLSearchParams
• History MDN web docs

Feel free to update this blog post on GitHub, thanks in advance!

Support me

I appreciate it if you would support me if have you enjoyed this post and found it useful, thank you in advance.

Share this post