fix: Add deprecation notice for getServerState() in WithReact type (#…

…2266)
pmndrs · Jan 20, 2024 · 43a2b11 · 43a2b11 · vercel · Jan 20, 2024
1 parent 740033c
commit 43a2b11
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/src/react.ts b/src/react.ts
@@ -23,6 +23,7 @@ type ExtractState<S> = S extends { getState: () => infer T } ? T : never
 type ReadonlyStoreApi<T> = Pick<StoreApi<T>, 'getState' | 'subscribe'>
 
 type WithReact<S extends ReadonlyStoreApi<unknown>> = S & {
+  /** @deprecated please use api.getState() */
   getServerState?: () => ExtractState<S>
 }
 

diff --git a/src/traditional.ts b/src/traditional.ts
@@ -23,6 +23,7 @@ type ExtractState<S> = S extends { getState: () => infer T } ? T : never
 type ReadonlyStoreApi<T> = Pick<StoreApi<T>, 'getState' | 'subscribe'>
 
 type WithReact<S extends ReadonlyStoreApi<unknown>> = S & {
+  /** @deprecated please use api.getState() */
   getServerState?: () => ExtractState<S>
 }