@automatons/validator 2.0.1 → 2.2.0

package/README.md

@@ -2,11 +2,14 @@
 
 The validator of openapi schema.
 
+Since v2 this package is **ESM-only** and requires **Node.js >= 22**.
+
 ## Usage
 
 ```typescript
 import {validator} from "@automatons/validator";
-import {readSync} from "fs";
+import {readFileSync} from "node:fs";
 
-const result = validator(readSync('path/to/openapi.json'))
+const result = await validator(JSON.parse(readFileSync("path/to/openapi.json", "utf-8")));
+// result.valid: boolean, result.errors: { keyword, rule, location }[]
 ```

package/index.d.ts

@@ -1,14 +1,14 @@
+type Validate = {
+    keyword: string;
+    rule: string;
+    location: string;
+};
 declare const validator: (openapi: {
     openapi: string;
-    [key: string]: any;
+    [key: string]: unknown;
 }) => Promise<{
     valid: boolean;
     errors: Validate[];
 }>;
-type Validate = {
-    keyword: string;
-    rule: string;
-    location: string;
-};
 
 export { type Validate, validator };