refactor: strong type for getFormHelpers name (#1029)

greyscaled · web-flow · commit cf8a20d6f6b8 · 2022-04-15T16:31:23.000-04:00
diff --git a/site/src/components/Form/index.ts b/site/src/components/Form/index.ts
@@ -17,8 +17,13 @@ interface FormHelpers {
   helperText?: string
 }
 
-export const getFormHelpers = <T>(form: FormikContextType<T>, name: string, error?: string): FormHelpers => {
-  // getIn is a util function from Formik that gets at any depth of nesting, and is necessary for the types to work
+export const getFormHelpers = <T>(form: FormikContextType<T>, name: keyof T, error?: string): FormHelpers => {
+  if (typeof name !== "string") {
+    throw new Error(`name must be type of string, instead received '${typeof name}'`)
+  }
+
+  // getIn is a util function from Formik that gets at any depth of nesting
+  // and is necessary for the types to work
   const touched = getIn(form.touched, name)
   const errors = error ?? getIn(form.errors, name)
   return {
