Merge pull request #157 from wellyshen/feature/change-parser-to-parse

Refactor(useForm): change the "parser" option of controller to "parse"

.changeset/mean-spoons-sing.md

@@ -0,0 +1,5 @@
+---
+"react-cool-form": patch
+---
+
+refactor(useForm): change the `parser` option of controller to `parse`

examples/src/BasicForm/Controller.tsx

@@ -1,7 +1,7 @@
 import { ChangeEvent, memo, useState } from "react";
 import {
  Controller as ControllerType,
- Parser,
+ Parse,
  FieldValidator,
 } from "react-cool-form";
 
@@ -31,7 +31,7 @@ const Controller = ({
  // console.log(`LOG ==> ${name} is re-rendered`);
 
  const [value, setValue] = useState(defaultValue);
- const parser: Parser<ChangeEvent<HTMLInputElement>> = (e) =>
+ const parse: Parse<ChangeEvent<HTMLInputElement>> = (e) =>
  e.target.value.length % 2 ? "case 1" : "case 2";
 
  return (
@@ -42,7 +42,7 @@ const Controller = ({
  validate,
  value,
  defaultValue: "welly",
- // parser,
+ // parse,
  onChange: (e, val) => {
  setValue(val);
  // setValue(e.target.value);

src/types/index.ts

@@ -165,7 +165,7 @@ export interface Controller<V, E = any> {
  validate?: FieldValidator<V>;
  value?: any;
  defaultValue?: any;
- parser?: (event: E) => any;
+ parse?: (event: E) => any;
  onChange?: (event: E, value?: any) => void;
  onBlur?: (event: FocusEvent<any>) => void;
  }

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

@@ -128,7 +128,7 @@ declare module "react-cool-form" {
  (event?: SyntheticEvent<any>): Promise<{ values?: V; errors?: Errors<V> }>;
  }
 
- export interface Parser<E = any, R = any> {
+ export interface Parse<E = any, R = any> {
  (event: E): R;
  }
 
@@ -147,7 +147,7 @@ declare module "react-cool-form" {
  validate?: FieldValidator<V>;
  value?: any;
  defaultValue?: any;
- parser?: Parser<E>;
+ parse?: Parse<E>;
  onChange?: OnChange<E>;
  onBlur?: OnBlur;
  }

src/useForm.ts

@@ -684,10 +684,7 @@ export default <V extends FormValues = FormValues>({
  );
 
  const controller = useCallback<Controller<V>>(
- (
- name,
- { validate, value, defaultValue, parser, onChange, onBlur } = {}
- ) => {
+ (name, { validate, value, defaultValue, parse, onChange, onBlur } = {}) => {
  if (!name) {
  warn('💡 react-cool-form > controller: Missing the "name" parameter.');
  return {};
@@ -701,7 +698,7 @@ export default <V extends FormValues = FormValues>({
  name,
  value: !isUndefined(value) ? value : getState(`values.${name}`) ?? "",
  onChange: (e) => {
- const parsedE = parser ? parser(e) : e;
+ const parsedE = parse ? parse(e) : e;
  let value;
 
  if (