doc: add jsdoc

Author: jorisre

README.md

@@ -28,27 +28,27 @@ Install your preferred validation library alongside `@hookform/resolvers`.
 <details>
   <summary>Resolver Comparison</summary>
 
-| resolver  | Infer values <br /> from schema |
-|---|---|
-| AJV  | ❌  |
-| Arktype |  ✅ |
-| class-validator  | ✅  |
-| computed-types  | ✅  |
-| Effect  | ✅  |
-| fluentvalidation-ts  | ❌  |
-| io-ts  | ✅  |
-| joi |  ❌ |
-| Nope  | ❌  |
-| Standard Schema  | ✅  |
-| Superstruct  | ✅  |
-| typanion  | ✅  |
-| typebox  | ✅  |
-| typeschema  | ❌  |
-| valibot  | ✅  |
-| vest  | ❌  |
-| vine  | ✅  |
-| yup  | ✅  |
-| zod  | ✅ |
+| resolver  | Infer values <br /> from schema | [criteriaMode](https://react-hook-form.com/docs/useform#criteriaMode) |
+|---|---|---|
+| AJV  | ❌  | `firstError | all` |
+| Arktype |  ✅ | `firstError` |
+| class-validator  | ✅  | `firstError | all` |
+| computed-types  | ✅  | `firstError` |
+| Effect  | ✅  | `firstError | all` |
+| fluentvalidation-ts  | ❌  | `firstError` |
+| io-ts  | ✅  | `firstError` |
+| joi |  ❌ | `firstError | all` |
+| Nope  | ❌  | `firstError` |
+| Standard Schema  | ✅  | `firstError | all` |
+| Superstruct  | ✅  | `firstError` |
+| typanion  | ✅  | `firstError` |
+| typebox  | ✅  | `firstError | all` |
+| typeschema  | ❌  | `firstError | all` |
+| valibot  | ✅  | `firstError | all` |
+| vest  | ❌  | `firstError | all` |
+| vine  | ✅  | `firstError | all` |
+| yup  | ✅  | `firstError | all` |
+| zod  | ✅ | `firstError | all` |
 </details>
 
 ## Links

ajv/src/ajv.ts

@@ -58,6 +58,26 @@ const parseErrorSchema = (
   return parsedErrors;
 };
 
+/**
+ * Creates a resolver for react-hook-form using Ajv schema validation
+ * @param {Schema} schema - The Ajv schema to validate against
+ * @param {Object} schemaOptions - Additional schema validation options
+ * @param {Object} resolverOptions - Additional resolver configuration
+ * @param {string} [resolverOptions.mode='async'] - Validation mode
+ * @returns {Resolver<Schema>} A resolver function compatible with react-hook-form
+ * @example
+ * const schema = ajv.compile({
+ *   type: 'object',
+ *   properties: {
+ *     name: { type: 'string' },
+ *     age: { type: 'number' }
+ *   }
+ * });
+ *
+ * useForm({
+ *   resolver: ajvResolver(schema)
+ * });
+ */
 export const ajvResolver: Resolver =
   (schema, schemaOptions, resolverOptions = {}) =>
   async (values, _, options) => {

arktype/src/arktype.ts

@@ -20,14 +20,25 @@ function parseErrorSchema(arkErrors: ArkErrors): Record<string, FieldError> {
   return fieldsErrors;
 }
 
+/**
+ * Creates a resolver for react-hook-form using Arktype schema validation
+ * @param {Schema} schema - The Arktype schema to validate against
+ * @param {Object} resolverOptions - Additional resolver configuration
+ * @param {string} [resolverOptions.mode='raw'] - Return the raw input values rather than the parsed values
+ * @returns {Resolver<Schema['inferOut']>} A resolver function compatible with react-hook-form
+ * @example
+ * const schema = type({
+ *   username: 'string>2'
+ * });
+ *
+ * useForm({
+ *   resolver: arktypeResolver(schema)
+ * });
+ */
 export function arktypeResolver<Schema extends Type<any, any>>(
   schema: Schema,
   _schemaOptions?: never,
   resolverOptions: {
-    /**
-     * Return the raw input values rather than the parsed values.
-     * @default false
-     */
     raw?: boolean;
   } = {},
 ): Resolver<Schema['inferOut']> {

bun.lock

@@ -42,6 +42,25 @@ function parseErrorSchema(
   }, parsedErrors);
 }
 
+/**
+ * Creates a resolver for react-hook-form using class-validator schema validation
+ * @param {ClassConstructor<Schema>} schema - The class-validator schema to validate against
+ * @param {Object} schemaOptions - Additional schema validation options
+ * @param {Object} resolverOptions - Additional resolver configuration
+ * @param {string} [resolverOptions.mode='async'] - Validation mode
+ * @returns {Resolver<Schema>} A resolver function compatible with react-hook-form
+ * @example
+ * class Schema {
+ *   @Matches(/^\w+$/)
+ *   @Length(3, 30)
+ *   username: string;
+ *   age: number
+ * }
+ *
+ * useForm({
+ *   resolver: classValidatorResolver(Schema)
+ * });
+ */
 export function classValidatorResolver<Schema extends Record<string, any>>(
   schema: ClassConstructor<Schema>,
   schemaOptions: {

bun.lockb

@@ -1,2 +1 @@
 export * from './class-validator';
-export * from './types';

class-validator/src/class-validator.ts

@@ -18,6 +18,20 @@ function parseErrorSchema(computedTypesError: ValidationError) {
   }, parsedErrors);
 }
 
+/**
+ * Creates a resolver for react-hook-form using computed-types schema validation
+ * @param {Schema} schema - The computed-types schema to validate against
+ * @returns {Resolver<Type<typeof schema>>} A resolver function compatible with react-hook-form
+ * @example
+ * const schema = Schema({
+ *   name: string,
+ *   age: number
+ * });
+ *
+ * useForm({
+ *   resolver: computedTypesResolver(schema)
+ * });
+ */
 export function computedTypesResolver<Schema extends FunctionType<any, any>>(
   schema: Schema,
 ): Resolver<Type<typeof schema>> {

class-validator/src/index.ts

@@ -9,6 +9,21 @@ import {
   appendErrors,
 } from 'react-hook-form';
 
+/**
+ * Creates a resolver for react-hook-form using Effect.ts schema validation
+ * @param {Schema.Schema<TFieldValues, I>} schema - The Effect.ts schema to validate against
+ * @param {ParseOptions} [schemaOptions] - Optional Effect.ts validation options
+ * @returns {Resolver<Schema.Schema.Type<typeof schema>>} A resolver function compatible with react-hook-form
+ * @example
+ * const schema = Schema.Struct({
+ *   name: Schema.String,
+ *   age: Schema.Number
+ * });
+ *
+ * useForm({
+ *   resolver: effectTsResolver(schema)
+ * });
+ */
 export function effectTsResolver<TFieldValues extends FieldValues, I>(
   schema: Schema.Schema<TFieldValues, I>,
   schemaOptions: ParseOptions = { errors: 'all', onExcessProperty: 'ignore' },