Fix useSearchParams comment (vercel#41483)

timneutkens · balazsorban44 · web-flow · commit ce60157b1b1e · 2022-10-17T19:07:07.000+02:00
Co-authored-by: Balázs Orbán &lt;info@balazsorban.com&gt;
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)

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,8 @@ class ReadonlyURLSearchParams {`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`
`72`		`- * Get the current search params. For example useSearchParams() would return {"foo": "bar"} when ?foo=bar`
	`72`	`+ * Get a read-only URLSearchParams object. For example searchParams.get('foo') would return 'bar' when ?foo=bar`
	`73`	`+ * Learn more about URLSearchParams here: https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams`
`73`	`74`	`*/`
`74`	`75`	`export function useSearchParams() {`
`75`	`76`	`const searchParams = useContext(SearchParamsContext)`