No return type for useFormik function

[sgronblo]

🐛 Bug report

Current Behavior

The return type for useFormik is defined inline.

Expected behavior

There should be a separate type defined for the return value of useFormik

Reproducible example

N/A

Suggested solution(s)

Add an explicit return type for useformik at

formik/src/Formik.tsx

Line 135 in d90149e

}: FormikConfig<Values>) {

Additional context

Trying to add formik step by step to an application. Want to specify the type of a component property that matches whatever useFormik returns. Currently I have to specify my own FormConfig type and add whatever I need there.

Your environment

Software	Version(s)
Formik	formik@2.0.3
React	react@16.9.0
TypeScript	typescript@3.5.3
Browser	Chrome Version 78.0.3904.87
npm/Yarn	yarn 1.19.1
Operating System	MacOS Mojave 1.14.6

[WestonThayer]

I have found FormikProps to be similar, but I’d like a type here too for use in sub component props.

[wbobeirne]

+1. Currently, if you want to use the return type of useFormik in another function, you have to type it as ReturnType<typeof useFormik>. However, useFormik is a generic argument, but you cannot specify generic arguments when using typeof. For example doing ReturnType<typeof useFormik<MyCustomFormValues>> is a syntax error.) So any object you pass in there that specified generic fields will result in the following error:

Argument of type '{ initialValues: MyCustomFormValues, initial...
  ...
  Type 'FormikValues' is not assignable to type 'MyCustomFormValues'

[davidroeca]

This makes wrapping useFormik with a custom wrapper mentioned in #2339 challenging/tedious when it comes to type safety/correctness.

EDIT: Looks like FormikConfig<Values> might be 👌
EDIT 2: Looks like FormikContextType<Values> is better

[stuart-clark-45]

Found a work around for this

export type Formik<T extends FormikValues> = ReturnType<typeof useFormik<T>>;