refactor(useForm): adjust the watch arg of getState()

wellyshen · Nov 25, 2020 · 35f9872 · 35f9872
1 parent ef681c9
commit 35f9872
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 7 deletions.
diff --git a/.changeset/tough-poets-sneeze.md b/.changeset/tough-poets-sneeze.md
@@ -0,0 +1,5 @@
+---
+"react-cool-form": patch
+---
+
+refactor(useForm): adjust the `watch` arg of `getState()`
diff --git a/examples/src/BasicForm/index.tsx b/examples/src/BasicForm/index.tsx
@@ -151,7 +151,7 @@ export default (): JSX.Element => {
  // submitCount: "submitCount",
  })
  ); */
- const errors = getState("errors", { watch: false });
+ const errors = getState("errors");
  console.log("LOG ===> ", errors);
 
  useEffect(() => {

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -104,7 +104,7 @@ export interface ValidateRef<V> {
 export interface GetState {
  (
  path: string | string[] | Record<string, string>,
- options?: { watch?: boolean; filterUntouchedErrors?: boolean }
+ watch?: { filterUntouchedErrors: boolean } | false
  ): any;
 }
 

diff --git a/src/types/react-cool-form.d.ts b/src/types/react-cool-form.d.ts
@@ -72,7 +72,7 @@ declare module "react-cool-form" {
  interface GetState {
  (
  path: string | string[] | Record<string, string>,
- options?: { watch?: boolean; filterUntouchedErrors?: boolean }
+ watch?: { filterUntouchedErrors: boolean } | false
  ): any;
  }
 

diff --git a/src/useForm.ts b/src/useForm.ts
@@ -259,9 +259,13 @@ export default <V extends FormValues = FormValues>({
  );
 
  const getState = useCallback<GetState>(
- (path, { watch = true, filterUntouchedErrors = true } = {}) => {
+ (path, watch = { filterUntouchedErrors: true }) => {
  const touchedErrorEnhancer = (path: string, state: any) => {
- if (!filterUntouchedErrors || !watch || !path.startsWith("errors"))
+ if (
+ !watch ||
+ !watch.filterUntouchedErrors ||
+ !path.startsWith("errors")
+ )
  return state;
 
  path = path.replace("errors", "touched");
@@ -559,8 +563,7 @@ export default <V extends FormValues = FormValues>({
 
  const getOptions = useCallback(
  () => ({
- getState: ((path, options = { watch: false }) =>
- getState(path, options)) as GetState,
+ getState: ((path, watch = false) => getState(path, watch)) as GetState,
  setErrors,
  setFieldError,
  setValues,