add: ValidateReturnType

Author: sagold

index.ts

@@ -1,6 +1,6 @@
 export { compileSchema } from "./src/compileSchema";
 export type { CompileOptions } from "./src/compileSchema";
-export type { Context, SchemaNode, GetNodeOptions } from "./src/SchemaNode";
+export type { Context, SchemaNode, GetNodeOptions, ValidateReturnType } from "./src/SchemaNode";
 export type { DataNode } from "./src/methods/toDataNodes";
 export type { Draft, DraftVersion } from "./src/Draft";
 export type { JsonError, JsonPointer, JsonSchema, OptionalNodeOrError, NodeOrError } from "./src/types";

src/SchemaNode.ts

@@ -155,6 +155,22 @@ export type GetNodeOptions = {
     pointer?: string;
 };
 
+export type ValidateReturnType = {
+    /**
+     * True, if data is valid to the compiled schema.
+     * Does not include async errors.
+     */
+    valid: boolean;
+    /**
+     * List of validation errors or empty
+     */
+    errors: JsonError[];
+    /**
+     * List of Promises resolving to `JsonError|undefined` or empty.
+     */
+    errorsAsync: Promise<JsonError | undefined>[];
+};
+
 export function joinDynamicId(a?: string, b?: string) {
     if (a == b) {
         return a ?? "";
@@ -334,7 +350,7 @@ export const SchemaNodeMethods = {
             }
         });
 
-        const result: { valid: boolean; errors: JsonError[]; errorsAsync: Promise<JsonError | undefined>[] } = {
+        const result: ValidateReturnType = {
             valid: flatErrorList.length === 0,
             errors: syncErrors,
             errorsAsync