remix 3.0.0-beta.0 → 3.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/fetch-router.d.ts +7 -0
- package/dist/fetch-router.d.ts.map +1 -1
- package/dist/node-tsx/load-module.d.ts +2 -0
- package/dist/node-tsx/load-module.d.ts.map +1 -0
- package/dist/node-tsx/load-module.js +2 -0
- package/dist/node-tsx.d.ts +3 -0
- package/dist/node-tsx.d.ts.map +1 -0
- package/{src/node-serve.ts → dist/node-tsx.js} +2 -1
- package/dist/render-middleware.d.ts +2 -0
- package/dist/render-middleware.d.ts.map +1 -0
- package/dist/render-middleware.js +2 -0
- package/dist/route-pattern/href.d.ts +2 -0
- package/dist/route-pattern/href.d.ts.map +1 -0
- package/dist/route-pattern/href.js +2 -0
- package/dist/route-pattern/join.d.ts +2 -0
- package/dist/route-pattern/join.d.ts.map +1 -0
- package/dist/route-pattern/join.js +2 -0
- package/dist/route-pattern/match.d.ts +2 -0
- package/dist/route-pattern/match.d.ts.map +1 -0
- package/dist/route-pattern/match.js +2 -0
- package/package.json +158 -44
- package/src/assert/README.md +109 -0
- package/src/assets/README.md +539 -0
- package/src/async-context-middleware/README.md +100 -0
- package/src/auth/README.md +445 -0
- package/src/auth-middleware/README.md +246 -0
- package/src/cli/README.md +78 -0
- package/src/compression-middleware/README.md +176 -0
- package/src/cookie/README.md +106 -0
- package/src/cop-middleware/README.md +117 -0
- package/src/cors-middleware/README.md +174 -0
- package/src/csrf-middleware/README.md +99 -0
- package/src/data-schema/README.md +422 -0
- package/src/data-table/README.md +552 -0
- package/src/data-table-mysql/README.md +97 -0
- package/src/data-table-postgres/README.md +74 -0
- package/src/data-table-sqlite/README.md +84 -0
- package/src/fetch-proxy/README.md +46 -0
- package/src/fetch-router/README.md +902 -0
- package/src/fetch-router.ts +7 -0
- package/src/file-storage/README.md +57 -0
- package/src/file-storage-s3/README.md +47 -0
- package/src/form-data-middleware/README.md +109 -0
- package/src/form-data-parser/README.md +160 -0
- package/src/fs/README.md +60 -0
- package/src/headers/README.md +629 -0
- package/src/html-template/README.md +101 -0
- package/src/lazy-file/README.md +109 -0
- package/src/logger-middleware/README.md +132 -0
- package/src/method-override-middleware/README.md +71 -0
- package/src/mime/README.md +110 -0
- package/src/multipart-parser/README.md +241 -0
- package/src/node-fetch-server/README.md +352 -0
- package/src/node-tsx/README.md +79 -0
- package/src/node-tsx/load-module.ts +2 -0
- package/{dist/node-serve.js → src/node-tsx.ts} +2 -1
- package/src/render-middleware/README.md +99 -0
- package/src/render-middleware.ts +2 -0
- package/src/route-pattern/README.md +291 -0
- package/src/route-pattern/href.ts +2 -0
- package/src/route-pattern/join.ts +2 -0
- package/src/route-pattern/match.ts +2 -0
- package/src/session/README.md +171 -0
- package/src/session-middleware/README.md +109 -0
- package/src/session-storage-memcache/README.md +37 -0
- package/src/session-storage-redis/README.md +37 -0
- package/src/static-middleware/README.md +89 -0
- package/src/tar-parser/README.md +74 -0
- package/src/terminal/README.md +92 -0
- package/src/test/README.md +430 -0
- package/src/ui/README.md +219 -0
- package/src/ui/accordion/README.md +166 -0
- package/src/ui/anchor/README.md +153 -0
- package/src/ui/animation/README.md +316 -0
- package/src/ui/breadcrumbs/README.md +55 -0
- package/src/ui/button/README.md +44 -0
- package/src/ui/combobox/README.md +145 -0
- package/src/ui/glyph/README.md +72 -0
- package/src/ui/listbox/README.md +115 -0
- package/src/ui/menu/README.md +96 -0
- package/src/ui/popover/README.md +122 -0
- package/src/ui/scroll-lock/README.md +33 -0
- package/src/ui/select/README.md +107 -0
- package/src/ui/server/README.md +90 -0
- package/src/ui/test/README.md +107 -0
- package/src/ui/theme/README.md +103 -0
- package/dist/node-serve.d.ts +0 -2
- package/dist/node-serve.d.ts.map +0 -1
package/dist/fetch-router.d.ts
CHANGED
|
@@ -1,2 +1,9 @@
|
|
|
1
1
|
export * from '@remix-run/fetch-router';
|
|
2
|
+
export interface RouterTypes {
|
|
3
|
+
}
|
|
4
|
+
type RemixRouterTypes = RouterTypes;
|
|
5
|
+
declare module '@remix-run/fetch-router' {
|
|
6
|
+
interface RouterTypes extends RemixRouterTypes {
|
|
7
|
+
}
|
|
8
|
+
}
|
|
2
9
|
//# sourceMappingURL=fetch-router.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fetch-router.d.ts","sourceRoot":"","sources":["../src/fetch-router.ts"],"names":[],"mappings":"AACA,cAAc,yBAAyB,CAAA"}
|
|
1
|
+
{"version":3,"file":"fetch-router.d.ts","sourceRoot":"","sources":["../src/fetch-router.ts"],"names":[],"mappings":"AACA,cAAc,yBAAyB,CAAA;AAEvC,MAAM,WAAW,WAAW;CAAG;AAC/B,KAAK,gBAAgB,GAAG,WAAW,CAAA;AAEnC,OAAO,QAAQ,yBAAyB,CAAC;IACvC,UAAU,WAAY,SAAQ,gBAAgB;KAAG;CAClD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"load-module.d.ts","sourceRoot":"","sources":["../../src/node-tsx/load-module.ts"],"names":[],"mappings":"AACA,cAAc,iCAAiC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"node-tsx.d.ts","sourceRoot":"","sources":["../src/node-tsx.ts"],"names":[],"mappings":"AACA,OAAO,qBAAqB,CAAA;AAC5B,OAAO,EAAE,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"render-middleware.d.ts","sourceRoot":"","sources":["../src/render-middleware.ts"],"names":[],"mappings":"AACA,cAAc,8BAA8B,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"href.d.ts","sourceRoot":"","sources":["../../src/route-pattern/href.ts"],"names":[],"mappings":"AACA,cAAc,+BAA+B,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"join.d.ts","sourceRoot":"","sources":["../../src/route-pattern/join.ts"],"names":[],"mappings":"AACA,cAAc,+BAA+B,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"match.d.ts","sourceRoot":"","sources":["../../src/route-pattern/match.ts"],"names":[],"mappings":"AACA,cAAc,gCAAgC,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "remix",
|
|
3
|
-
"version": "3.0.0-beta.
|
|
3
|
+
"version": "3.0.0-beta.2",
|
|
4
4
|
"description": "The Remix web framework",
|
|
5
5
|
"author": "Michael Jackson <mjijackson@gmail.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -109,14 +109,26 @@
|
|
|
109
109
|
"types": "./dist/data-table/migrations/node.d.ts",
|
|
110
110
|
"default": "./dist/data-table/migrations/node.js"
|
|
111
111
|
},
|
|
112
|
+
"./data-table/mysql": {
|
|
113
|
+
"types": "./dist/data-table-mysql.d.ts",
|
|
114
|
+
"default": "./dist/data-table-mysql.js"
|
|
115
|
+
},
|
|
112
116
|
"./data-table/operators": {
|
|
113
117
|
"types": "./dist/data-table/operators.d.ts",
|
|
114
118
|
"default": "./dist/data-table/operators.js"
|
|
115
119
|
},
|
|
120
|
+
"./data-table/postgres": {
|
|
121
|
+
"types": "./dist/data-table-postgres.d.ts",
|
|
122
|
+
"default": "./dist/data-table-postgres.js"
|
|
123
|
+
},
|
|
116
124
|
"./data-table/sql-helpers": {
|
|
117
125
|
"types": "./dist/data-table/sql-helpers.d.ts",
|
|
118
126
|
"default": "./dist/data-table/sql-helpers.js"
|
|
119
127
|
},
|
|
128
|
+
"./data-table/sqlite": {
|
|
129
|
+
"types": "./dist/data-table-sqlite.d.ts",
|
|
130
|
+
"default": "./dist/data-table-sqlite.js"
|
|
131
|
+
},
|
|
120
132
|
"./fetch-proxy": {
|
|
121
133
|
"types": "./dist/fetch-proxy.d.ts",
|
|
122
134
|
"default": "./dist/fetch-proxy.js"
|
|
@@ -145,6 +157,10 @@
|
|
|
145
157
|
"types": "./dist/file-storage/memory.d.ts",
|
|
146
158
|
"default": "./dist/file-storage/memory.js"
|
|
147
159
|
},
|
|
160
|
+
"./file-storage/s3": {
|
|
161
|
+
"types": "./dist/file-storage-s3.d.ts",
|
|
162
|
+
"default": "./dist/file-storage-s3.js"
|
|
163
|
+
},
|
|
148
164
|
"./form-data-middleware": {
|
|
149
165
|
"types": "./dist/form-data-middleware.d.ts",
|
|
150
166
|
"default": "./dist/form-data-middleware.js"
|
|
@@ -177,6 +193,54 @@
|
|
|
177
193
|
"types": "./dist/method-override-middleware.d.ts",
|
|
178
194
|
"default": "./dist/method-override-middleware.js"
|
|
179
195
|
},
|
|
196
|
+
"./middleware/async-context": {
|
|
197
|
+
"types": "./dist/async-context-middleware.d.ts",
|
|
198
|
+
"default": "./dist/async-context-middleware.js"
|
|
199
|
+
},
|
|
200
|
+
"./middleware/auth": {
|
|
201
|
+
"types": "./dist/auth-middleware.d.ts",
|
|
202
|
+
"default": "./dist/auth-middleware.js"
|
|
203
|
+
},
|
|
204
|
+
"./middleware/compression": {
|
|
205
|
+
"types": "./dist/compression-middleware.d.ts",
|
|
206
|
+
"default": "./dist/compression-middleware.js"
|
|
207
|
+
},
|
|
208
|
+
"./middleware/cop": {
|
|
209
|
+
"types": "./dist/cop-middleware.d.ts",
|
|
210
|
+
"default": "./dist/cop-middleware.js"
|
|
211
|
+
},
|
|
212
|
+
"./middleware/cors": {
|
|
213
|
+
"types": "./dist/cors-middleware.d.ts",
|
|
214
|
+
"default": "./dist/cors-middleware.js"
|
|
215
|
+
},
|
|
216
|
+
"./middleware/csrf": {
|
|
217
|
+
"types": "./dist/csrf-middleware.d.ts",
|
|
218
|
+
"default": "./dist/csrf-middleware.js"
|
|
219
|
+
},
|
|
220
|
+
"./middleware/form-data": {
|
|
221
|
+
"types": "./dist/form-data-middleware.d.ts",
|
|
222
|
+
"default": "./dist/form-data-middleware.js"
|
|
223
|
+
},
|
|
224
|
+
"./middleware/logger": {
|
|
225
|
+
"types": "./dist/logger-middleware.d.ts",
|
|
226
|
+
"default": "./dist/logger-middleware.js"
|
|
227
|
+
},
|
|
228
|
+
"./middleware/method-override": {
|
|
229
|
+
"types": "./dist/method-override-middleware.d.ts",
|
|
230
|
+
"default": "./dist/method-override-middleware.js"
|
|
231
|
+
},
|
|
232
|
+
"./middleware/render": {
|
|
233
|
+
"types": "./dist/render-middleware.d.ts",
|
|
234
|
+
"default": "./dist/render-middleware.js"
|
|
235
|
+
},
|
|
236
|
+
"./middleware/session": {
|
|
237
|
+
"types": "./dist/session-middleware.d.ts",
|
|
238
|
+
"default": "./dist/session-middleware.js"
|
|
239
|
+
},
|
|
240
|
+
"./middleware/static": {
|
|
241
|
+
"types": "./dist/static-middleware.d.ts",
|
|
242
|
+
"default": "./dist/static-middleware.js"
|
|
243
|
+
},
|
|
180
244
|
"./mime": {
|
|
181
245
|
"types": "./dist/mime.d.ts",
|
|
182
246
|
"default": "./dist/mime.js"
|
|
@@ -197,9 +261,17 @@
|
|
|
197
261
|
"types": "./dist/node-fetch-server/test.d.ts",
|
|
198
262
|
"default": "./dist/node-fetch-server/test.js"
|
|
199
263
|
},
|
|
200
|
-
"./node-
|
|
201
|
-
"types": "./dist/node-
|
|
202
|
-
"default": "./dist/node-
|
|
264
|
+
"./node-tsx": {
|
|
265
|
+
"types": "./dist/node-tsx.d.ts",
|
|
266
|
+
"default": "./dist/node-tsx.js"
|
|
267
|
+
},
|
|
268
|
+
"./node-tsx/load-module": {
|
|
269
|
+
"types": "./dist/node-tsx/load-module.d.ts",
|
|
270
|
+
"default": "./dist/node-tsx/load-module.js"
|
|
271
|
+
},
|
|
272
|
+
"./render-middleware": {
|
|
273
|
+
"types": "./dist/render-middleware.d.ts",
|
|
274
|
+
"default": "./dist/render-middleware.js"
|
|
203
275
|
},
|
|
204
276
|
"./response/compress": {
|
|
205
277
|
"types": "./dist/response/compress.d.ts",
|
|
@@ -221,10 +293,30 @@
|
|
|
221
293
|
"types": "./dist/route-pattern.d.ts",
|
|
222
294
|
"default": "./dist/route-pattern.js"
|
|
223
295
|
},
|
|
296
|
+
"./route-pattern/href": {
|
|
297
|
+
"types": "./dist/route-pattern/href.d.ts",
|
|
298
|
+
"default": "./dist/route-pattern/href.js"
|
|
299
|
+
},
|
|
300
|
+
"./route-pattern/join": {
|
|
301
|
+
"types": "./dist/route-pattern/join.d.ts",
|
|
302
|
+
"default": "./dist/route-pattern/join.js"
|
|
303
|
+
},
|
|
304
|
+
"./route-pattern/match": {
|
|
305
|
+
"types": "./dist/route-pattern/match.d.ts",
|
|
306
|
+
"default": "./dist/route-pattern/match.js"
|
|
307
|
+
},
|
|
224
308
|
"./route-pattern/specificity": {
|
|
225
309
|
"types": "./dist/route-pattern/specificity.d.ts",
|
|
226
310
|
"default": "./dist/route-pattern/specificity.js"
|
|
227
311
|
},
|
|
312
|
+
"./router": {
|
|
313
|
+
"types": "./dist/fetch-router.d.ts",
|
|
314
|
+
"default": "./dist/fetch-router.js"
|
|
315
|
+
},
|
|
316
|
+
"./routes": {
|
|
317
|
+
"types": "./dist/fetch-router/routes.d.ts",
|
|
318
|
+
"default": "./dist/fetch-router/routes.js"
|
|
319
|
+
},
|
|
228
320
|
"./session": {
|
|
229
321
|
"types": "./dist/session.d.ts",
|
|
230
322
|
"default": "./dist/session.js"
|
|
@@ -241,6 +333,26 @@
|
|
|
241
333
|
"types": "./dist/session-storage-redis.d.ts",
|
|
242
334
|
"default": "./dist/session-storage-redis.js"
|
|
243
335
|
},
|
|
336
|
+
"./session-storage/cookie": {
|
|
337
|
+
"types": "./dist/session/cookie-storage.d.ts",
|
|
338
|
+
"default": "./dist/session/cookie-storage.js"
|
|
339
|
+
},
|
|
340
|
+
"./session-storage/fs": {
|
|
341
|
+
"types": "./dist/session/fs-storage.d.ts",
|
|
342
|
+
"default": "./dist/session/fs-storage.js"
|
|
343
|
+
},
|
|
344
|
+
"./session-storage/memcache": {
|
|
345
|
+
"types": "./dist/session-storage-memcache.d.ts",
|
|
346
|
+
"default": "./dist/session-storage-memcache.js"
|
|
347
|
+
},
|
|
348
|
+
"./session-storage/memory": {
|
|
349
|
+
"types": "./dist/session/memory-storage.d.ts",
|
|
350
|
+
"default": "./dist/session/memory-storage.js"
|
|
351
|
+
},
|
|
352
|
+
"./session-storage/redis": {
|
|
353
|
+
"types": "./dist/session-storage-redis.d.ts",
|
|
354
|
+
"default": "./dist/session-storage-redis.js"
|
|
355
|
+
},
|
|
244
356
|
"./session/cookie-storage": {
|
|
245
357
|
"types": "./dist/session/cookie-storage.d.ts",
|
|
246
358
|
"default": "./dist/session/cookie-storage.js"
|
|
@@ -357,49 +469,50 @@
|
|
|
357
469
|
"typescript": "^5.9.3"
|
|
358
470
|
},
|
|
359
471
|
"dependencies": {
|
|
360
|
-
"@remix-run/assets": "^0.
|
|
361
|
-
"@remix-run/
|
|
362
|
-
"@remix-run/
|
|
363
|
-
"@remix-run/
|
|
364
|
-
"@remix-run/cop-middleware": "^0.1.
|
|
365
|
-
"@remix-run/
|
|
366
|
-
"@remix-run/
|
|
472
|
+
"@remix-run/assets": "^0.4.1",
|
|
473
|
+
"@remix-run/async-context-middleware": "^0.3.1",
|
|
474
|
+
"@remix-run/auth": "^0.2.3",
|
|
475
|
+
"@remix-run/ui": "^0.2.0",
|
|
476
|
+
"@remix-run/cop-middleware": "^0.1.4",
|
|
477
|
+
"@remix-run/compression-middleware": "^0.1.9",
|
|
478
|
+
"@remix-run/cookie": "^0.5.3",
|
|
479
|
+
"@remix-run/auth-middleware": "^0.2.1",
|
|
480
|
+
"@remix-run/cors-middleware": "^0.1.4",
|
|
481
|
+
"@remix-run/csrf-middleware": "^0.1.4",
|
|
367
482
|
"@remix-run/data-schema": "^0.3.0",
|
|
368
|
-
"@remix-run/
|
|
369
|
-
"@remix-run/data-table": "^0.
|
|
370
|
-
"@remix-run/
|
|
371
|
-
"@remix-run/data-table-
|
|
372
|
-
"@remix-run/
|
|
373
|
-
"@remix-run/fetch-
|
|
374
|
-
"@remix-run/
|
|
375
|
-
"@remix-run/
|
|
376
|
-
"@remix-run/data-
|
|
377
|
-
"@remix-run/file-storage-s3": "^0.1.
|
|
378
|
-
"@remix-run/
|
|
379
|
-
"@remix-run/
|
|
380
|
-
"@remix-run/
|
|
381
|
-
"@remix-run/
|
|
382
|
-
"@remix-run/
|
|
383
|
-
"@remix-run/html-template": "^0.3.0",
|
|
384
|
-
"@remix-run/headers": "^0.19.0",
|
|
385
|
-
"@remix-run/logger-middleware": "^0.2.1",
|
|
483
|
+
"@remix-run/data-table": "^0.3.0",
|
|
484
|
+
"@remix-run/data-table-mysql": "^0.4.0",
|
|
485
|
+
"@remix-run/data-table-postgres": "^0.4.0",
|
|
486
|
+
"@remix-run/data-table-sqlite": "^0.5.0",
|
|
487
|
+
"@remix-run/fetch-proxy": "^0.8.2",
|
|
488
|
+
"@remix-run/fetch-router": "^0.19.1",
|
|
489
|
+
"@remix-run/file-storage": "^0.13.5",
|
|
490
|
+
"@remix-run/form-data-middleware": "^0.3.1",
|
|
491
|
+
"@remix-run/form-data-parser": "^0.17.2",
|
|
492
|
+
"@remix-run/file-storage-s3": "^0.1.2",
|
|
493
|
+
"@remix-run/fs": "^0.4.4",
|
|
494
|
+
"@remix-run/html-template": "^0.3.1",
|
|
495
|
+
"@remix-run/headers": "^0.21.0",
|
|
496
|
+
"@remix-run/lazy-file": "^5.0.4",
|
|
497
|
+
"@remix-run/logger-middleware": "^0.3.1",
|
|
386
498
|
"@remix-run/mime": "^0.4.1",
|
|
387
|
-
"@remix-run/
|
|
388
|
-
"@remix-run/
|
|
389
|
-
"@remix-run/node-fetch-server": "^0.13.
|
|
390
|
-
"@remix-run/
|
|
391
|
-
"@remix-run/
|
|
392
|
-
"@remix-run/
|
|
393
|
-
"@remix-run/
|
|
394
|
-
"@remix-run/
|
|
395
|
-
"@remix-run/session-storage-
|
|
499
|
+
"@remix-run/multipart-parser": "^0.16.2",
|
|
500
|
+
"@remix-run/method-override-middleware": "^0.1.9",
|
|
501
|
+
"@remix-run/node-fetch-server": "^0.13.3",
|
|
502
|
+
"@remix-run/node-tsx": "^0.1.1",
|
|
503
|
+
"@remix-run/route-pattern": "^0.21.1",
|
|
504
|
+
"@remix-run/session": "^0.4.2",
|
|
505
|
+
"@remix-run/response": "^0.3.5",
|
|
506
|
+
"@remix-run/session-middleware": "^0.3.1",
|
|
507
|
+
"@remix-run/session-storage-memcache": "^0.1.1",
|
|
508
|
+
"@remix-run/static-middleware": "^0.4.10",
|
|
509
|
+
"@remix-run/session-storage-redis": "^0.1.1",
|
|
396
510
|
"@remix-run/tar-parser": "^0.7.1",
|
|
397
|
-
"@remix-run/
|
|
398
|
-
"@remix-run/
|
|
399
|
-
"@remix-run/
|
|
400
|
-
"@remix-run/terminal": "^0.1.
|
|
401
|
-
"@remix-run/
|
|
402
|
-
"@remix-run/test": "^0.3.0"
|
|
511
|
+
"@remix-run/assert": "^0.2.1",
|
|
512
|
+
"@remix-run/cli": "^0.3.1",
|
|
513
|
+
"@remix-run/render-middleware": "^0.1.1",
|
|
514
|
+
"@remix-run/terminal": "^0.1.1",
|
|
515
|
+
"@remix-run/test": "^0.4.1"
|
|
403
516
|
},
|
|
404
517
|
"bin": {
|
|
405
518
|
"remix": "./dist/cli-entry.js"
|
|
@@ -427,6 +540,7 @@
|
|
|
427
540
|
"scripts": {
|
|
428
541
|
"build": "tsc -p tsconfig.build.json",
|
|
429
542
|
"clean": "git clean -fdX",
|
|
543
|
+
"test": "remix-test",
|
|
430
544
|
"typecheck": "tsc --noEmit"
|
|
431
545
|
}
|
|
432
546
|
}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# assert
|
|
2
|
+
|
|
3
|
+
A compatible subset of `node:assert/strict` that works in any JavaScript environment, including browsers — plus a vitest-/jest-style `expect` API for tests that prefer chainable matchers.
|
|
4
|
+
|
|
5
|
+
Uses strict equality (`===`) for all comparisons — no type coercion.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- `AssertionError` — compatible with `node:assert.AssertionError` (`actual`, `expected`, `operator`, `name`)
|
|
10
|
+
- `assert.ok` — truthy check
|
|
11
|
+
- `assert.equal` / `assert.notEqual` — strict equality (`===` / `!==`)
|
|
12
|
+
- `assert.deepEqual` / `assert.notDeepEqual` — recursive strict deep equality
|
|
13
|
+
- `assert.match` — string matches a regexp
|
|
14
|
+
- `assert.fail` — unconditional failure
|
|
15
|
+
- `assert.throws` — synchronous throw assertion with optional error validation
|
|
16
|
+
- `assert.rejects` — async rejection assertion with optional error validation
|
|
17
|
+
- `expect(value)` — chainable matchers with `.not`, `.rejects`, `.resolves`, plus `expect.objectContaining(...)` for partial matches
|
|
18
|
+
|
|
19
|
+
## Installation
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
npm i remix
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
Mirrors `node:assert/strict` — uses strict equality (`===`), so `1 !== '1'` and `null !== undefined`.
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import assert from 'remix/assert'
|
|
31
|
+
|
|
32
|
+
assert.ok(true)
|
|
33
|
+
assert.equal(1, 1)
|
|
34
|
+
assert.equal(1, '1') // throws — different types
|
|
35
|
+
assert.notEqual('a', 'b')
|
|
36
|
+
assert.deepEqual({ a: 1 }, { a: 1 })
|
|
37
|
+
assert.deepEqual({ a: 1 }, { a: '1' }) // throws — different types
|
|
38
|
+
assert.match('hello world', /world/)
|
|
39
|
+
assert.fail('should not reach here')
|
|
40
|
+
|
|
41
|
+
await assert.rejects(() => Promise.reject(new Error('oops')))
|
|
42
|
+
assert.throws(() => {
|
|
43
|
+
throw new TypeError('bad')
|
|
44
|
+
}, TypeError)
|
|
45
|
+
|
|
46
|
+
assert.throws(
|
|
47
|
+
() => {
|
|
48
|
+
let error = new Error('Invalid value') as Error & { code: string }
|
|
49
|
+
error.code = 'ERR_INVALID_ARG_VALUE'
|
|
50
|
+
throw error
|
|
51
|
+
},
|
|
52
|
+
{ code: 'ERR_INVALID_ARG_VALUE', message: /Invalid value/ },
|
|
53
|
+
)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Named exports
|
|
57
|
+
|
|
58
|
+
Each assertion is also exported as a named function:
|
|
59
|
+
|
|
60
|
+
```ts
|
|
61
|
+
import {
|
|
62
|
+
ok,
|
|
63
|
+
assert, // alias of ok()
|
|
64
|
+
equal,
|
|
65
|
+
notEqual,
|
|
66
|
+
deepEqual,
|
|
67
|
+
notDeepEqual,
|
|
68
|
+
match,
|
|
69
|
+
fail,
|
|
70
|
+
throws,
|
|
71
|
+
rejects,
|
|
72
|
+
} from 'remix/assert'
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### `expect`
|
|
76
|
+
|
|
77
|
+
A vitest-/jest-style chainable matcher API on top of the same `AssertionError`. Use `.not` to negate, `.rejects` / `.resolves` to assert on a promise. Mock-aware matchers work with `mock.fn()` / `mock.method()` from `remix/test`.
|
|
78
|
+
|
|
79
|
+
```ts
|
|
80
|
+
import { expect } from 'remix/assert'
|
|
81
|
+
|
|
82
|
+
expect(value).toBe(42)
|
|
83
|
+
expect({ a: 1, b: 2 }).toEqual({ a: 1, b: 2 })
|
|
84
|
+
expect({ a: 1, b: 2 }).toEqual(expect.objectContaining({ a: 1 }))
|
|
85
|
+
expect({ a: { b: 1, c: 2 } }).toMatchObject({ a: { b: 1 } })
|
|
86
|
+
expect(value).not.toBeNull()
|
|
87
|
+
expect(arr).toHaveLength(3)
|
|
88
|
+
expect(spy).toHaveBeenCalledWith('hello', 1)
|
|
89
|
+
|
|
90
|
+
await expect(fetch('/missing')).rejects.toThrow('Not found')
|
|
91
|
+
await expect(loadModule()).resolves.toBeUndefined()
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Available matchers:
|
|
95
|
+
|
|
96
|
+
| Group | Matchers |
|
|
97
|
+
| --------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
98
|
+
| Equality | `toBe`, `toEqual`, `toBeNull`, `toBeUndefined`, `toBeDefined`, `toBeTruthy`, `toBeInstanceOf` |
|
|
99
|
+
| Numbers | `toBeGreaterThan`, `toBeGreaterThanOrEqual`, `toBeLessThan`, `toBeLessThanOrEqual`, `toBeCloseTo` |
|
|
100
|
+
| String/iterable | `toContain`, `toMatch`, `toHaveLength` |
|
|
101
|
+
| Object shape | `toHaveProperty(path, value?)`, `toMatchObject(partial)` |
|
|
102
|
+
| Throwing | `toThrow(expected?)` |
|
|
103
|
+
| Mock-aware | `toHaveBeenCalled`, `toHaveBeenCalledTimes(n)`, `toHaveBeenCalledWith(...args)`, `toHaveBeenNthCalledWith(nth, ...args)` |
|
|
104
|
+
|
|
105
|
+
`expect.objectContaining(partial)` is an asymmetric matcher recognized by `toEqual` (and any matcher that uses deep equality under the hood). It passes when the actual value has at least the keys in `partial` with matching values — extra keys are allowed.
|
|
106
|
+
|
|
107
|
+
## License
|
|
108
|
+
|
|
109
|
+
See [LICENSE](https://github.com/remix-run/remix/blob/main/LICENSE)
|