v9.0.0 🚀 - Reverse & Compile

Author: DZakh

.github/workflows/ci.yml

@@ -260,7 +260,7 @@ jobs:
       - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22.6.0
           cache: "pnpm"
       - run: pnpm install
 

.gitignore

@@ -6,3 +6,4 @@ lib
 coverage
 dist
 packages/artifacts
+.tsimp

IDEAS.md

@@ -18,11 +18,6 @@ let trimContract: S.contract<string => string> = S.contract(s => {
 
 - Use internal transform for trim
 
-## v9
-
-- Update documentation:
-  - Add Enums section to js docs
-
 ### Done
 
 - Removed deprecated APIs, check S.resi diff, S.d.ts and RescriptSchema.gen.ts

docs/js-usage.md

@@ -1311,9 +1311,9 @@ This is literally the same as convert operations applied to the reversed schema.
 
 For some cases you might want to simply assert the input value is valid. For this there's `S.assertOrThrow` operation:
 
-| Operation       | Interface                   | Description                           |
-| --------------- | --------------------------- | ------------------------------------- |
-| S.assertOrThrow | `('any, S.t<'value>) => ()` | Asserts that the input value is valid |
+| Operation       | Interface                   | Description                                                                                                                                          |
+| --------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| S.assertOrThrow | `('any, S.t<'value>) => ()` | Asserts that the input value is valid. Since the operation doesn't return a value, it's 2-3 times faster than `parseOrThrow` depending on the schema |
 
 All operations either return the output value or raise an exception which you can catch with `try/catch` block:
 
@@ -1330,13 +1330,13 @@ try true->S.parseOrThrow(schema) catch {
 If you want to have the most possible performance, or the built-in operations doesn't cover your specific use case, you can use `compile` to create fine-tuned operation functions.
 
 ```rescript
-let fn = S.compile(
+let operation = S.compile(
   S.string,
   ~input=Any,
   ~output=Assert,
   ~mode=Async,
 )
-await fn("Hello world!")
+await operation("Hello world!")
 // ()
 ```
 
@@ -1356,7 +1356,7 @@ You can configure compiled function `output` with the following options:
 - `Unknown` - returns `unknown`
 - `Assert` - returns `unit`
 - `Json` - validates that the schema is JSON compatible and returns `Js.Json.t`
-- `JsonString` - validates that the schema is JSON compatible and transforms output to JSON string
+- `JsonString` - validates that the schema is JSON compatible and converts output to JSON string
 
 You can configure compiled function `mode` with the following options:
 

docs/rescript-usage.md

@@ -68,7 +68,7 @@
     ],
     "nodeArguments": [
       "--no-warnings",
-      "--loader=ts-node/esm"
+      "--import=tsimp"
     ]
   },
   "devDependencies": {
@@ -81,7 +81,7 @@
     "rescript-stdlib-vendorer": "1.1.0",
     "rescript-schema": "link:",
     "ts-expect": "1.3.0",
-    "ts-node": "10.9.1",
+    "tsimp": "2.0.12",
     "typescript": "4.9.3",
     "valibot": "0.42.1",
     "zod": "3.24.1"