Refactor(types): enhance the readability of type

.changeset/small-forks-doubt.md

@@ -0,0 +1,5 @@
+---
+"react-cool-form": patch
+---
+
+refactor(types): enhance the readability of type

src/types/index.ts

@@ -59,12 +59,12 @@ export type Fields = Record<
  }
 >;
 
-export type FieldParsers = Record<
+export type FieldArgs = Record<
  string,
  {
  valueAsNumber?: boolean;
  valueAsDate?: boolean;
- parse?: Parse;
+ parse?: Parser;
  }
 >;
 
@@ -80,19 +80,19 @@ interface Options<V> {
  submit: Submit<V>;
 }
 
-interface OnReset<V> {
+interface ResetHandler<V> {
  (values: V, options: Options<V>, event?: Event | SyntheticEvent<any>): void;
 }
 
-interface OnSubmit<V> {
+interface SubmitHandler<V> {
  (
  values: V,
  options: Options<V>,
  event?: Event | SyntheticEvent<any>
  ): void | Promise<void>;
 }
 
-interface OnError<V> {
+interface ErrorHandler<V> {
  (
  errors: Errors<V>,
  options: Options<V>,
@@ -120,7 +120,7 @@ export interface FieldRef<V> {
  validate?: FieldValidator<V>;
  valueAsNumber?: boolean;
  valueAsDate?: boolean;
- parse?: Parse;
+ parse?: Parser;
  }
  ): (field: FieldElement | null) => void;
 }
@@ -193,11 +193,11 @@ export interface Submit<V> {
  (event?: SyntheticEvent<any>): Promise<{ values?: V; errors?: Errors<V> }>;
 }
 
-interface Parse {
+interface Parser {
  (value: any): any;
 }
 
-type format = Parse;
+type Formatter = Parser;
 
 export interface Controller<V, E = any> {
  (
@@ -206,8 +206,8 @@ export interface Controller<V, E = any> {
  validate?: FieldValidator<V>;
  value?: any;
  defaultValue?: any;
- parse?: Parse;
- format?: format;
+ parse?: Parser;
+ format?: Formatter;
  onChange?: (event: E, value: any) => void;
  onBlur?: (event: FocusEvent<any>) => void;
  }
@@ -226,9 +226,9 @@ export interface Config<V> {
  validateOnBlur?: boolean;
  removeUnmountedField?: boolean;
  ignoreFields?: string[];
- onReset?: OnReset<V>;
- onSubmit?: OnSubmit<V>;
- onError?: OnError<V>;
+ onReset?: ResetHandler<V>;
+ onSubmit?: SubmitHandler<V>;
+ onError?: ErrorHandler<V>;
  debug?: Debug<V>;
 }
 

src/types/react-cool-form.d.ts

@@ -34,19 +34,19 @@ declare module "react-cool-form" {
  submit: Submit<V>;
  }
 
- export interface OnReset<V = FormValues> {
+ export interface ResetHandler<V = FormValues> {
  (values: V, options: Options<V>, event?: Event | SyntheticEvent<any>): void;
  }
 
- export interface OnSubmit<V = FormValues> {
+ export interface SubmitHandler<V = FormValues> {
  (
  values: V,
  options: Options<V>,
  event?: Event | SyntheticEvent<any>
  ): void | Promise<void>;
  }
 
- export interface OnError<V = FormValues> {
+ export interface ErrorHandler<V = FormValues> {
  (
  errors: Errors<V>,
  options: Options<V>,
@@ -74,7 +74,7 @@ declare module "react-cool-form" {
  validate?: FieldValidator<V>;
  valueAsNumber?: boolean;
  valueAsDate?: boolean;
- parse?: Parse;
+ parse?: Parser;
  }
  ): (
  field: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | null
@@ -161,17 +161,17 @@ declare module "react-cool-form" {
  (event?: SyntheticEvent<any>): Promise<{ values?: V; errors?: Errors<V> }>;
  }
 
- export interface Parse<V = any, R = any> {
+ export interface Parser<V = any, R = any> {
  (value: V): R;
  }
 
- export type Format<V = any, R = any> = Parse<V, R>;
+ export type Formatter<V = any, R = any> = Parser<V, R>;
 
- export interface OnChange<E = any> {
+ export interface ChangeHandler<E = any> {
  (event: E, value: any): void;
  }
 
- export interface OnBlur {
+ export interface BlurHandler {
  (event: FocusEvent<any>): void;
  }
 
@@ -182,16 +182,16 @@ declare module "react-cool-form" {
  validate?: FieldValidator<V>;
  value?: any;
  defaultValue?: any;
- parse?: Parse;
- format?: Format;
- onChange?: OnChange<E>;
- onBlur?: OnBlur;
+ parse?: Parser;
+ format?: Formatter;
+ onChange?: ChangeHandler<E>;
+ onBlur?: BlurHandler;
  }
  ): {
  name: string;
  value: any;
  onChange: (event: E) => void;
- onBlur: OnBlur;
+ onBlur: BlurHandler;
  } | void;
  }
 
@@ -202,9 +202,9 @@ declare module "react-cool-form" {
  validateOnBlur?: boolean;
  removeUnmountedField?: boolean;
  ignoreFields?: string[];
- onReset?: OnReset<V>;
- onSubmit?: OnSubmit<V>;
- onError?: OnError<V>;
+ onReset?: ResetHandler<V>;
+ onSubmit?: SubmitHandler<V>;
+ onError?: ErrorHandler<V>;
  debug?: Debug<V>;
  }
 

src/useForm.ts

@@ -6,8 +6,8 @@ import {
  Config,
  Controller,
  Errors,
+ FieldArgs,
  FieldElement,
- FieldParsers,
  FieldRef,
  Fields,
  FieldValidator,
@@ -66,7 +66,7 @@ export default <V extends FormValues = FormValues>({
  const isInitRef = useRef(true);
  const formRef = useRef<HTMLFormElement>(null);
  const fieldsRef = useRef<Fields>({});
- const fieldParsersRef = useRef<FieldParsers>({});
+ const fieldArgsRef = useRef<FieldArgs>({});
  const controllersRef = useRef<Map>({});
  const ignoreFieldsRef = useRef<Map>(arrayToMap(ignoreFields));
  const changedFieldRef = useRef<string>();
@@ -156,7 +156,7 @@ export default <V extends FormValues = FormValues>({
  const { validate, ...parsers } = validateOrOptions;
 
  if (validate) fieldValidatorsRef.current[field.name] = validate;
- fieldParsersRef.current[field.name] = parsers;
+ fieldArgsRef.current[field.name] = parsers;
  },
  []
  );
@@ -167,11 +167,11 @@ export default <V extends FormValues = FormValues>({
  let value = field.value as any;
 
  if (isInputElement(field)) {
- if (fieldParsersRef.current[name]?.valueAsNumber) {
+ if (fieldArgsRef.current[name]?.valueAsNumber) {
  value = field.valueAsNumber;
  return value;
  }
- if (fieldParsersRef.current[name]?.valueAsDate) {
+ if (fieldArgsRef.current[name]?.valueAsDate) {
  value = field.valueAsDate;
  return value;
  }
@@ -796,7 +796,7 @@ export default <V extends FormValues = FormValues>({
  }
 
  if (fieldsRef.current[name] && !controllersRef.current[name]) {
- const parse = fieldParsersRef.current[name]?.parse;
+ const parse = fieldArgsRef.current[name]?.parse;
  const value = getNodeValue(name);
 
  handleChangeEvent(name, parse ? parse(value) : value);
@@ -866,7 +866,7 @@ export default <V extends FormValues = FormValues>({
  true
  );
 
- delete fieldParsersRef.current[name];
+ delete fieldArgsRef.current[name];
  delete fieldValidatorsRef.current[name];
  delete controllersRef.current[name];
  });