How do you remove a query parameter?

[nikkwong]

I notice that there's setParams() in expo-router, but it doesn't have a way to clear current query parameters. I can pass an empty object to setParams like setParams({}) but the items in the query remain. How can this be achieved?

[nikkwong]

Ping

[marklawlor]

Set the value to undefined

setParams({ "remove-this-value": undefined })

[nikkwong]

This, for a brief period, actually triggers a re-render with the param set as the string "undefined" in the router.

const { remove_this_value } = useSearchParams()
console.log(remove_this_value); // will be "undefined" for at least one render

Which I can hack to get around, but I'm hoping this api improves in the future. Thanks!

[andredewaard]

I also get 'undefined' as value for the param, any way to get around this and completely remove the param?

[trymbill]

If setting the value to undefined is the solution then that should probably be documented and the types updated, right?

router/packages/expo-router/src/types.ts

Line 29 in f92f699

setParams: (params?: Record<string, string>) => void;

[marklawlor]

Yes, it appears that was missed. It will be fixed in this PR expo/expo#25654

[trymbill]

It doesn't look like it's just the types that are off, I've tried setting a query parameter to null and undefined and it just sets it to the stringified version of "null" and "undefined" respectively 🤔

[NilsBaumgartner1994]

Might be related to this issue: expo/expo#26565 ?

[codinsonn]

Am I correct in assuming you cannot yet clear params in SDK 51 by either

• passing an empty object?
• setting the value to null or undefined?

Tried today, but to no avail. Would love to hear of any other solutions that worked for you.

[NilsBaumgartner1994]

’’’
router.setParams({test: undefined})
’’’

That's how it works for me

[NilsBaumgartner1994]

But yes, I was also facing some weird bugs with Params.

[komfysach]

Also facing the same issue, is there an update on this?

[erickreutz]

This still seems to be an issue? router.setParams({ search: undefined }) results in search to be "undefined"

[twoodruff01]

Just stumbled across this with the exact same problem as described by @erickreutz

[mysa-mudit]

still looking for a solution for this

[billsbooth]

Yep, still doesn't work 😭

I am writing a deep link handler, and wanted to clear the param when I have handled the link; since removing the param doesn't actually remove it, it ends up in an infinite loop!

[dineshsalunke]

For anyone still struggling with this issue here is the patch which stops the undefined and null from converting to string

diff --git a/build/hooks.js b/build/hooks.js
index 55f5792af2d1b81cfa92e7ee7e57744bba4c0b71..5695e4933a8a2fba98e71fbf0e23ced129d7c4bf 100644
--- a/build/hooks.js
+++ b/build/hooks.js
@@ -134,7 +134,9 @@ function useLocalSearchParams() {
                     }
                 }),
             ];
-        }
+       } else if ( typeof value === 'undefined' || value === null) {
+           return [key, value]
+       }
         else {
             try {
                 return [key, decodeURIComponent(value)];

[dineshsalunke]

I have raised a pull request with the above patch

expo/expo#34950