adjusts jsdocs

payloadcms · Dec 2, 2024 · 4bf4181 · 4bf4181
1 parent 4f39762
commit 4bf4181
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/packages/ui/src/providers/Params/index.tsx b/packages/ui/src/providers/Params/index.tsx
@@ -10,7 +10,7 @@ const Context = createContext<IParamsContext>({} as IParamsContext)
 
 /**
  * @deprecated
- * This provider is deprecated and will be removed in the next major release. Instead, use the `useParams` hook from `next/navigation` instead. See https://github.com/payloadcms/payload/pull/9576.
+ * The ParamsProvider is deprecated and will be removed in the next major release. Instead, use the `useParams` hook from `next/navigation` directly. See https://github.com/payloadcms/payload/pull/9581.
  * @example
  * ```tsx
  * import { useParams } from 'next/navigation'
@@ -23,7 +23,7 @@ export const ParamsProvider: React.FC<{ children?: React.ReactNode }> = ({ child
 
 /**
  * @deprecated
- * This provider is deprecated and will be removed in the next major release. Instead, use the `useParams` hook from `next/navigation` instead. See https://github.com/payloadcms/payload/pull/9576.
+ * The `useParams` hook is deprecated and will be removed in the next major release. Instead, use the `useParams` hook from `next/navigation` directly. See https://github.com/payloadcms/payload/pull/9581.
  * @example
  * ```tsx
  * import { useParams } from 'next/navigation'

diff --git a/packages/ui/src/providers/SearchParams/index.tsx b/packages/ui/src/providers/SearchParams/index.tsx
@@ -20,7 +20,7 @@ const Context = createContext(initialContext)
 
 /**
  * @deprecated
- * This provider is deprecated and will be removed in the next major release. Instead, use the `useSearchParams` hook from `next/navigation` instead. See https://github.com/payloadcms/payload/pull/9576.
+ * The SearchParamsProvider is deprecated and will be removed in the next major release. Instead, use the `useSearchParams` hook from `next/navigation` directly. See https://github.com/payloadcms/payload/pull/9581.
  * @example
  * ```tsx
  * import { useSearchParams } from 'next/navigation'
@@ -53,10 +53,15 @@ export const SearchParamsProvider: React.FC<{ children?: React.ReactNode }> = ({
 
 /**
  * @deprecated
- * This provider is deprecated and will be removed in the next major release. Instead, use the `useParams` hook from `next/navigation` instead. See https://github.com/payloadcms/payload/pull/9576.
+ * The `useSearchParams` hook is deprecated and will be removed in the next major release. Instead, use the `useSearchParams` hook from `next/navigation` directly. See https://github.com/payloadcms/payload/pull/9581.
  * @example
  * ```tsx
- * import { useParams } from 'next/navigation'
+ * import { useSearchParams } from 'next/navigation'
+ * ```
+ * If you need to parse the `where` query, you can do so with the `parseSearchParams` utility.
+ * ```tsx
+ * import { parseSearchParams } from '@payloadcms/ui'
+ * const parsedSearchParams = parseSearchParams(searchParams)
  * ```
  */
 export const useSearchParams = (): SearchParamsContext => useContext(Context)