nuqs/packages/nuqs/src/api.test.ts at 98841c48d7741dda89be3292595224cc31cb1862 · 47ng/nuqs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
import { fileURLToPath } from 'node:url'
import { expect, it } from 'vitest'
import { getPackageExportsManifest } from 'vitest-package-exports'

// Update the snapshot when updating the API
// (and adjust the documentation accordingly).
const exports = `
{
  ".": {
    "createLoader": "function",
    "createMultiParser": "function",
    "createParser": "function",
    "createSerializer": "function",
    "createStandardSchemaV1": "function",
    "debounce": "function",
    "defaultRateLimit": "object",
    "parseAsArrayOf": "function",
    "parseAsBoolean": "object",
    "parseAsFloat": "object",
    "parseAsHex": "object",
    "parseAsIndex": "object",
    "parseAsInteger": "object",
    "parseAsIsoDate": "object",
    "parseAsIsoDateTime": "object",
    "parseAsJson": "function",
    "parseAsNativeArrayOf": "function",
    "parseAsNumberLiteral": "function",
    "parseAsString": "object",
    "parseAsStringEnum": "function",
    "parseAsStringLiteral": "function",
    "parseAsTimestamp": "object",
    "throttle": "function",
    "useQueryState": "function",
    "useQueryStates": "function",
  },
  "./adapters/custom": {
    "renderQueryString": "function",
    "unstable_createAdapterProvider": "function",
  },
  "./adapters/next": {
    "NuqsAdapter": "function",
  },
  "./adapters/next/app": {
    "NuqsAdapter": "function",
  },
  "./adapters/next/pages": {
    "NuqsAdapter": "function",
  },
  "./adapters/react": {
    "NuqsAdapter": "function",
    "enableHistorySync": "function",
  },
  "./adapters/react-router": {
    "NuqsAdapter": "function",
    "useOptimisticSearchParams": "function",
  },
  "./adapters/react-router/v6": {
    "NuqsAdapter": "function",
    "useOptimisticSearchParams": "function",
  },
  "./adapters/react-router/v7": {
    "NuqsAdapter": "function",
    "useOptimisticSearchParams": "function",
  },
  "./adapters/remix": {
    "NuqsAdapter": "function",
    "useOptimisticSearchParams": "function",
  },
  "./adapters/tanstack-router": {
    "NuqsAdapter": "function",
  },
  "./adapters/testing": {
    "NuqsTestingAdapter": "function",
    "withNuqsTestingAdapter": "function",
  },
  "./lib": {
    "safeParse": "function",
  },
  "./server": {
    "createLoader": "function",
    "createMultiParser": "function",
    "createParser": "function",
    "createSearchParamsCache": "function",
    "createSerializer": "function",
    "createStandardSchemaV1": "function",
    "debounce": "function",
    "defaultRateLimit": "object",
    "parseAsArrayOf": "function",
    "parseAsBoolean": "object",
    "parseAsFloat": "object",
    "parseAsHex": "object",
    "parseAsIndex": "object",
    "parseAsInteger": "object",
    "parseAsIsoDate": "object",
    "parseAsIsoDateTime": "object",
    "parseAsJson": "function",
    "parseAsNativeArrayOf": "function",
    "parseAsNumberLiteral": "function",
    "parseAsString": "object",
    "parseAsStringEnum": "function",
    "parseAsStringLiteral": "function",
    "parseAsTimestamp": "object",
    "throttle": "function",
  },
  "./testing": {
    "isParserBijective": "function",
    "testParseThenSerialize": "function",
    "testSerializeThenParse": "function",
  },
}
`

it('has a stable exported API (dist)', async () => {
  const manifest = await getPackageExportsManifest({
    importMode: 'dist',
    cwd: fileURLToPath(import.meta.url)
  })
  expect(manifest.exports).toMatchInlineSnapshot(exports)
})