test: Add type tests

Author: franky47

packages/nuqs/tests/useQueryState.test-d.ts

@@ -1,5 +1,11 @@
 import { describe, expectTypeOf, it } from 'vitest'
-import { parseAsString, useQueryState } from '../dist'
+import {
+  debounce,
+  defaultRateLimit,
+  parseAsString,
+  throttle,
+  useQueryState
+} from '../dist'
 
 describe('types/useQueryState', () => {
   it('has a nullable string state by default', () => {
@@ -117,4 +123,54 @@ describe('types/useQueryState', () => {
     // @ts-expect-error
     setBar(() => undefined)
   })
+  it('accepts a limitUrlUpdates option', () => {
+    useQueryState('foo', {
+      limitUrlUpdates: {
+        method: 'throttle',
+        timeMs: 100
+      }
+    })
+    useQueryState('foo', {
+      limitUrlUpdates: {
+        method: 'debounce',
+        timeMs: 100
+      }
+    })
+    useQueryState('foo', { limitUrlUpdates: throttle(100) })
+    useQueryState('foo', { limitUrlUpdates: debounce(100) })
+    useQueryState('foo', { limitUrlUpdates: defaultRateLimit })
+    // Using parsers options (builder pattern)
+    parseAsString.withOptions({
+      limitUrlUpdates: {
+        method: 'throttle',
+        timeMs: 100
+      }
+    })
+    parseAsString.withOptions({
+      limitUrlUpdates: {
+        method: 'debounce',
+        timeMs: 100
+      }
+    })
+    parseAsString.withOptions({ limitUrlUpdates: throttle(100) })
+    parseAsString.withOptions({ limitUrlUpdates: debounce(100) })
+    parseAsString.withOptions({ limitUrlUpdates: defaultRateLimit })
+    // State updater function
+    const [, setState] = useQueryState('foo')
+    setState(null, {
+      limitUrlUpdates: {
+        method: 'throttle',
+        timeMs: 100
+      }
+    })
+    setState(null, {
+      limitUrlUpdates: {
+        method: 'debounce',
+        timeMs: 100
+      }
+    })
+    setState(null, { limitUrlUpdates: throttle(100) })
+    setState(null, { limitUrlUpdates: debounce(100) })
+    setState(null, { limitUrlUpdates: defaultRateLimit })
+  })
 })

packages/nuqs/tests/useQueryStates.test-d.ts

@@ -1,5 +1,12 @@
 import { describe, expectTypeOf, it } from 'vitest'
-import { parseAsInteger, parseAsString, useQueryStates } from '../dist'
+import {
+  debounce,
+  defaultRateLimit,
+  parseAsInteger,
+  parseAsString,
+  throttle,
+  useQueryStates
+} from '../dist'
 
 describe('types/useQueryStates', () => {
   const parsers = {
@@ -93,4 +100,40 @@ describe('types/useQueryStates', () => {
       }
     })
   })
+  it('accepts a limitUrlUpdates option', () => {
+    // Hook-level definition
+    const parsers = { foo: parseAsString }
+    useQueryStates(parsers, {
+      limitUrlUpdates: {
+        method: 'throttle',
+        timeMs: 100
+      }
+    })
+    useQueryStates(parsers, {
+      limitUrlUpdates: {
+        method: 'debounce',
+        timeMs: 100
+      }
+    })
+    useQueryStates(parsers, { limitUrlUpdates: throttle(100) })
+    useQueryStates(parsers, { limitUrlUpdates: debounce(100) })
+    useQueryStates(parsers, { limitUrlUpdates: defaultRateLimit })
+    // State updater function
+    const [, setState] = useQueryStates(parsers)
+    setState(null, {
+      limitUrlUpdates: {
+        method: 'throttle',
+        timeMs: 100
+      }
+    })
+    setState(null, {
+      limitUrlUpdates: {
+        method: 'debounce',
+        timeMs: 100
+      }
+    })
+    setState(null, { limitUrlUpdates: throttle(100) })
+    setState(null, { limitUrlUpdates: debounce(100) })
+    setState(null, { limitUrlUpdates: defaultRateLimit })
+  })
 })