fix: fix setUrl options as second argument

asmyshlyaev177 · Nov 14, 2024 · 4b6d277 · 4b6d277
1 parent 518e7bb
commit 4b6d277
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 4 deletions.
diff --git a/packages/example-nextjs14/src/app/Form-for-test.tsx b/packages/example-nextjs14/src/app/Form-for-test.tsx
@@ -45,6 +45,8 @@ export const Form = ({
       setState((st) => ({ ...st, age: 18 }));
       setUrl(urlState);
       setUrl((st) => ({ ...st, age: 18 }));
+      setUrl(urlState, { replace: true });
+      setUrl((st) => ({ ...st, age: 18 }), { replace: true });
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);

diff --git a/packages/example-nextjs15/src/app/Form-for-test.tsx b/packages/example-nextjs15/src/app/Form-for-test.tsx
@@ -43,6 +43,8 @@ export const Form = ({
       setState((st) => ({ ...st, age: 18 }));
       setUrl(urlState);
       setUrl((st) => ({ ...st, age: 18 }));
+      setUrl(urlState, { replace: true });
+      setUrl((st) => ({ ...st, age: 18 }), { replace: true });
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);

diff --git a/packages/example-react-router6/src/Form-for-test.tsx b/packages/example-react-router6/src/Form-for-test.tsx
@@ -35,6 +35,8 @@ export const Form = ({ className }: { className?: string }) => {
       setState((st) => ({ ...st, age: 18 }));
       setUrl(urlState);
       setUrl((st) => ({ ...st, age: 18 }));
+      setUrl(urlState, { replace: true });
+      setUrl((st) => ({ ...st, age: 18 }), { replace: true });
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);

diff --git a/packages/urlstate/next/useUrlState/useUrlState.ts b/packages/urlstate/next/useUrlState/useUrlState.ts
@@ -63,7 +63,10 @@ export function useUrlState<T extends JSONCompatible>(
 ): {
   urlState: T;
   setState: (value: Partial<T> | ((currState: T) => T)) => void;
-  setUrl: (value?: Partial<T> | ((currState: T) => T)) => void;
+  setUrl: (
+    value?: Partial<T> | ((currState: T) => T),
+    options?: Options,
+  ) => void;
 };
 
 export function useUrlState<T extends JSONCompatible>(

diff --git a/packages/urlstate/react-router/useUrlState/useUrlState.ts b/packages/urlstate/react-router/useUrlState/useUrlState.ts
@@ -61,7 +61,10 @@ export function useUrlState<T extends JSONCompatible>(
 ): {
   urlState: T;
   setState: (value: Partial<T> | ((currState: T) => T)) => void;
-  setUrl: (value?: Partial<T> | ((currState: T) => T)) => void;
+  setUrl: (
+    value?: Partial<T> | ((currState: T) => T),
+    options?: Params,
+  ) => void;
 };
 
 export function useUrlState<T extends JSONCompatible>(
@@ -140,7 +143,7 @@ export function useUrlState<T extends JSONCompatible>(
      * // or
      * setState(curr => ({ ...curr, name: 'test' }) );
      * // can pass optional React-Router `NavigateOptions`
-     * setState(curr => ({ ...curr, name: 'test', preventScrollReset: false }) );
+     * setState(curr => ({ ...curr, name: 'test' }) );
      *  ```
      *
      *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState#updatestate}
@@ -157,7 +160,7 @@ export function useUrlState<T extends JSONCompatible>(
      * // or
      * setUrl(curr => ({ ...curr, name: 'test' }), { replace: true } );
      * // can pass optional React-Router `NavigateOptions`
-     * setState(curr => ({ ...curr, name: 'test', preventScrollReset: false }) );
+     * setUrl(curr => ({ ...curr, name: 'test' }), { preventScrollReset: false } );
      *  ```
      *
      *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState#updateurl}