ref: Normalise API for queues (separate timeMs from options)

Author: franky47

packages/nuqs/src/lib/queues/throttle.test.ts

@@ -94,22 +94,22 @@ describe('throttle: ThrottleQueue option combination logic', () => {
   })
   it('keeps the maximum value for timeMs', () => {
     const queue = new ThrottledQueue()
-    queue.push({ key: 'a', query: null, options: {}, timeMs: 100 })
-    queue.push({ key: 'b', query: null, options: {}, timeMs: 200 })
-    queue.push({ key: 'c', query: null, options: {}, timeMs: 300 })
+    queue.push({ key: 'a', query: null, options: {} }, 100)
+    queue.push({ key: 'b', query: null, options: {} }, 200)
+    queue.push({ key: 'c', query: null, options: {} }, 300)
     expect(queue.timeMs).toEqual(300)
   })
   it('clamps the minimum value for timeMs to the default rate limit', () => {
     expect(defaultRateLimit.timeMs).toBeGreaterThan(10) // precondition
     const queue = new ThrottledQueue()
-    queue.push({ key: 'a', query: null, options: {}, timeMs: 10 })
+    queue.push({ key: 'a', query: null, options: {} }, 10)
     expect(queue.timeMs).toEqual(defaultRateLimit.timeMs)
   })
   it('supports passing Infinity to the timeMs option (but can be cleared)', () => {
     const queue = new ThrottledQueue()
-    queue.push({ key: 'a', query: null, options: {}, timeMs: Infinity })
+    queue.push({ key: 'a', query: null, options: {} }, Infinity)
     expect(queue.timeMs).toBe(Infinity)
-    queue.push({ key: 'b', query: null, options: {}, timeMs: 100 })
+    queue.push({ key: 'b', query: null, options: {} }, 100)
     expect(queue.timeMs).toBe(100)
   })
 })

packages/nuqs/src/lib/queues/throttle.ts

@@ -20,7 +20,6 @@ export type UpdateQueuePushArgs = {
   key: string
   query: string | null
   options: AdapterOptions & Pick<Options, 'startTransition'>
-  timeMs?: number
 }
 
 function getSearchParamsSnapshotFromLocation() {
@@ -39,12 +38,10 @@ export class ThrottledQueue {
   resolvers: Resolvers<URLSearchParams> | null = null
   lastFlushedAt = 0
 
-  push({
-    key,
-    query,
-    options,
+  push(
+    { key, query, options }: UpdateQueuePushArgs,
     timeMs = defaultRateLimit.timeMs
-  }: UpdateQueuePushArgs) {
+  ) {
     debug('[nuqs queue] Enqueueing %s=%s %O', key, query, options)
     // Enqueue update
     this.updateMap.set(key, query)

packages/nuqs/src/useQueryState.ts

@@ -306,12 +306,12 @@ export function useQueryState<T = string>(
           defaultRateLimit.timeMs
         return debounceController.push(update, timeMs, adapter)
       } else {
-        update.throttleMs =
+        const timeMs =
           options.limitUrlUpdates?.timeMs ??
           limitUrlUpdates?.timeMs ??
           options.throttleMs ??
           throttleMs
-        globalThrottleQueue.push(update)
+        globalThrottleQueue.push(update, timeMs)
         return globalThrottleQueue.flush(adapter)
       }
     },

packages/nuqs/src/useQueryStates.ts

@@ -274,14 +274,14 @@ export function useQueryStates<KeyMap extends UseQueryStatesKeysMap>(
             maxDebounceTime = timeMs
           }
         } else {
-          update.throttleMs =
+          const timeMs =
             callOptions?.limitUrlUpdates?.timeMs ??
             parser?.limitUrlUpdates?.timeMs ??
             limitUrlUpdates?.timeMs ??
             callOptions.throttleMs ??
             parser.throttleMs ??
             throttleMs
-          globalThrottleQueue.push(update)
+          globalThrottleQueue.push(update, timeMs)
         }
       }
       // We need to flush the throttle queue, but we may have a pending