Fix useSearchParams comment

vercel · Oct 17, 2022 · 4923557 · 4923557
1 parent 7be2ef0
commit 4923557
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/packages/next/client/components/navigation.ts b/packages/next/client/components/navigation.ts
@@ -69,7 +69,8 @@ class ReadonlyURLSearchParams {
 }
 
 /**
- * Get the current search params. For example useSearchParams() would return {"foo": "bar"} when ?foo=bar
+ * Get a read-only URLSearchParams object. For example searchParams.get('foo') would return 'bar' when ?foo=bar
+ * Learn more about URLSearchParams here: https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams
  */
 export function useSearchParams() {
   const searchParams = useContext(SearchParamsContext)