tanstack-url-state 0.2.0 → 0.2.1

package/README.md

@@ -44,7 +44,7 @@ function SettingsRoute() {
 - **Optimistic:** every hook reading a key sees the new value at once, before the URL changes.
 - **Batched:** updates in the same tick (or inside a `debounce` window) become one navigation.
 - **Removal:** `null`, `undefined`, `""` and `[]` remove the key, which then reads as its default.
-- **Setters return a promise** that resolves once the URL holds the update.
+- **Setters return a promise** that resolves once the URL holds the update, or rejects with the router's error if the navigation fails (the state then reads the URL again).
 
 Options, per hook or per call:
 

package/dist/use-search-state.js

@@ -7,7 +7,7 @@ let pending = EMPTY;
 let queued = null;
 let timer;
 let nextFlush = null;
-let resolveFlush;
+let settleFlush;
 const listeners = new Set();
 const subscribe = (listener) => {
     listeners.add(listener);
@@ -21,13 +21,15 @@ const emit = () => {
     }
 };
 const isEmpty = (value) => value === null || value === undefined || value === "" || (Array.isArray(value) && value.length === 0);
+// Runs from a timer, so it never throws: a failed navigation rejects the setters' promise instead.
 async function flush() {
     timer = undefined;
     const sent = pending;
     const job = queued;
-    const resolve = resolveFlush;
+    const settle = settleFlush;
     queued = null;
     nextFlush = null;
+    let failure;
     try {
         if (job) {
             const patch = Object.fromEntries(Object.entries(sent).map(([key, value]) => [key, isEmpty(value) ? undefined : value]));
@@ -39,12 +41,21 @@ async function flush() {
             });
         }
     }
+    catch (error) {
+        failure = { error };
+    }
     finally {
-        // The URL now owns what was sent; keep only values set again while navigating.
+        // The URL now owns what was sent (or kept its old values if navigating failed);
+        // keep only values set again while navigating.
         const rest = Object.fromEntries(Object.entries(pending).filter(([key, value]) => sent[key] !== value));
         pending = Object.keys(rest).length > 0 ? rest : EMPTY;
         emit();
-        resolve?.();
+        if (failure) {
+            settle?.reject(failure.error);
+        }
+        else {
+            settle?.resolve();
+        }
     }
 }
 function enqueue(router, patch, options) {
@@ -54,8 +65,8 @@ function enqueue(router, patch, options) {
         push: queued?.push === true || options.history === "push",
         scroll: queued?.scroll === true || options.scroll === true,
     };
-    nextFlush ??= new Promise((resolve) => {
-        resolveFlush = resolve;
+    nextFlush ??= new Promise((resolve, reject) => {
+        settleFlush = { resolve, reject };
     });
     emit();
     clearTimeout(timer);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tanstack-url-state",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "nuqs-style URL search state for TanStack Router, typed by each route's validateSearch",
   "license": "MIT",
   "type": "module",