refactor: change getFromState() to getState()

wellyshen · Nov 9, 2020 · d23d838 · d23d838
1 parent 98cd808
commit d23d838
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 12 deletions.
diff --git a/.changeset/silent-guests-judge.md b/.changeset/silent-guests-judge.md
@@ -0,0 +1,5 @@
+---
+"react-cool-form": patch
+---
+
+refactor: change getFromState() to getState()
diff --git a/src/types/index.ts b/src/types/index.ts
@@ -104,7 +104,7 @@ export interface ValidateRef<V> {
   (validate: FieldValidator<V>): (field: FieldElement | null) => void;
 }
 
-export interface GetFormState {
+export interface GetState {
   (path: string | string[] | Record<string, string>, watch?: boolean): any;
 }
 
@@ -193,7 +193,7 @@ export interface Config<V> {
 export interface Return<V> {
   formRef: RefObject<HTMLFormElement>;
   validate: ValidateRef<V>;
-  getFormState: GetFormState;
+  getState: GetState;
   setErrors: SetErrors<V>;
   setFieldError: SetFieldError;
   setValues: SetValues<V>;

diff --git a/src/types/react-cool-form.d.ts b/src/types/react-cool-form.d.ts
@@ -61,7 +61,7 @@ declare module "react-cool-form" {
     ) => void;
   }
 
-  interface GetFormState {
+  interface GetState {
     (path: string | string[] | Record<string, string>, watch?: boolean): any;
   }
 
@@ -164,7 +164,7 @@ declare module "react-cool-form" {
   export interface Return<V = FormValues> {
     formRef: RefObject<HTMLFormElement>;
     validate: ValidateRef<V>;
-    getFormState: GetFormState;
+    getState: GetState;
     setErrors: SetErrors<V>;
     setFieldError: SetFieldError;
     setValues: SetValues<V>;

diff --git a/src/useForm.ts b/src/useForm.ts
@@ -14,7 +14,7 @@ import {
   Fields,
   FieldValidator,
   FormValues,
-  GetFormState,
+  GetState,
   Reset,
   Return,
   SetErrors,
@@ -170,7 +170,7 @@ export function useForm<V extends FormValues = FormValues>({
     []
   );
 
-  const getFormState = useCallback<GetFormState>(
+  const getState = useCallback<GetState>(
     (path, watch = true) => {
       let state;
 
@@ -425,8 +425,8 @@ export function useForm<V extends FormValues = FormValues>({
 
   const getOptions = useCallback(
     () => ({
-      getFormState: ((path, watch = false) =>
-        getFormState(path, watch)) as GetFormState,
+      getState: ((path, watch = false) =>
+        getState(path, watch)) as GetState,
       setErrors,
       setFieldError,
       setValues,
@@ -436,7 +436,7 @@ export function useForm<V extends FormValues = FormValues>({
       reset,
     }),
     [
-      getFormState,
+      getState,
       reset,
       setErrors,
       setFieldError,
@@ -552,7 +552,7 @@ export function useForm<V extends FormValues = FormValues>({
 
       return {
         name,
-        value: !isUndefined(value) ? value : getFormState(`values.${name}`),
+        value: !isUndefined(value) ? value : getState(`values.${name}`),
         // eslint-disable-next-line react-hooks/rules-of-hooks
         onChange: useCallback(
           (e) => {
@@ -583,7 +583,7 @@ export function useForm<V extends FormValues = FormValues>({
     },
     [
       getChangeEventValue,
-      getFormState,
+      getState,
       handleFieldChange,
       setFieldTouchedIfNeeded,
       setFieldValue,
@@ -659,7 +659,7 @@ export function useForm<V extends FormValues = FormValues>({
   return {
     formRef,
     validate: validateRef,
-    getFormState,
+    getState,
     setErrors,
     setFieldError,
     setValues,