Docs: update SSR and Query docs to include notes about TS and useHydr…

…ateAtom (#2882) * Add Typescript note to Query Client example * docs: add ts instructions for useHydrateAtoms to query and ssr --------- Co-authored-by: Daishi Kato <[email protected]>
pmndrs · Dec 22, 2024 · 1d5ba26 · 1d5ba26
1 parent 7883c4e
commit 1d5ba26
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/extensions/query.mdx b/docs/extensions/query.mdx
@@ -263,6 +263,8 @@ Although they reference methods same query key (`'todos'`), the `onSuccess` inva
 
 This will result in `todosAtom` showing stale data as it was not prompted to refetch.
 
+⚠️ Note: When using **Typescript**, it is recommended to use a Map when passing the queryClient value to useHydrateAtoms. You can find a working example in the [Initializing State on Render docs](https://jotai.org/docs/guides/initialize-atom-on-render#using-typescript)
+
 ```jsx
 import { Provider } from 'jotai/react'
 import { useHydrateAtoms } from 'jotai/react/utils'

diff --git a/docs/utilities/ssr.mdx b/docs/utilities/ssr.mdx
@@ -90,6 +90,8 @@ useHydrateAtoms([
 ] as const)
 ```
 
+Or you may need to use a Map when passing the atom value to useHydrateAtoms. You can find a working example in the [Initializing State on Render docs](https://jotai.org/docs/guides/initialize-atom-on-render#using-typescript).
+
 ### Demo
 
 <Stackblitz id="stackblitz-starters-b7cvxi" file="pages%2Findex.tsx" />