Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(types): make types on functions extend off the base classes generics #1268

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 79 additions & 65 deletions packages/form-core/src/FormApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -193,40 +193,43 @@ export interface FormValidators<
*/
export interface FormTransform<
TFormData,
TOnMount extends undefined | FormValidateOrFn<TFormData>,
TOnChange extends undefined | FormValidateOrFn<TFormData>,
TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
TOnBlur extends undefined | FormValidateOrFn<TFormData>,
TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
TSubmitMeta = never,
> {
fn: (
fn: <
TFFormData extends TFormData,
TFOnMount extends undefined | FormValidateOrFn<TFFormData>,
TFOnChange extends undefined | FormValidateOrFn<TFFormData>,
TFOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFFormData>,
TFOnBlur extends undefined | FormValidateOrFn<TFFormData>,
TFOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFFormData>,
TFOnSubmit extends undefined | FormValidateOrFn<TFFormData>,
TFOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFFormData>,
TFOnServer extends undefined | FormValidateOrFn<TFFormData>,
TFSubmitMeta extends TSubmitMeta
>(
formBase: FormApi<
TFormData,
TOnMount,
TOnChange,
TOnChangeAsync,
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync,
TOnServer,
TSubmitMeta
TFFormData,
TFOnMount,
TFOnChange,
TFOnChangeAsync,
TFOnBlur,
TFOnBlurAsync,
TFOnSubmit,
TFOnSubmitAsync,
TFOnServer,
TFSubmitMeta
>,
) => FormApi<
TFormData,
TOnMount,
TOnChange,
TOnChangeAsync,
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync,
TOnServer,
TSubmitMeta
TFFormData,
TFOnMount,
TFOnChange,
TFOnChangeAsync,
TFOnBlur,
TFOnBlurAsync,
TFOnSubmit,
TFOnSubmitAsync,
TFOnServer,
TFSubmitMeta
>
deps: unknown[]
}
Expand Down Expand Up @@ -296,52 +299,63 @@ export interface FormOptions<
/**
* A function to be called when the form is submitted, what should happen once the user submits a valid form returns `any` or a promise `Promise<any>`
*/
onSubmit?: (props: {
value: TFormData
onSubmit?: <
TFFormData extends TFormData,
TFOnMount extends undefined | FormValidateOrFn<TFFormData>,
TFOnChange extends undefined | FormValidateOrFn<TFFormData>,
TFOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFFormData>,
TFOnBlur extends undefined | FormValidateOrFn<TFFormData>,
TFOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFFormData>,
TFOnSubmit extends undefined | FormValidateOrFn<TFFormData>,
TFOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFFormData>,
TFOnServer extends undefined | FormValidateOrFn<TFFormData>,
TFSubmitMeta extends TSubmitMeta
>(props: {
value: TFFormData
formApi: FormApi<
TFormData,
TOnMount,
TOnChange,
TOnChangeAsync,
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync,
TOnServer,
TSubmitMeta
TFFormData,
TFOnMount,
TFOnChange,
TFOnChangeAsync,
TFOnBlur,
TFOnBlurAsync,
TFOnSubmit,
TFOnSubmitAsync,
TFOnServer,
TFSubmitMeta
>
meta: TSubmitMeta
}) => any | Promise<any>
/**
* Specify an action for scenarios where the user tries to submit an invalid form.
*/
onSubmitInvalid?: (props: {
value: TFormData
onSubmitInvalid?: <
TFFormData extends TFormData,
TFOnMount extends undefined | FormValidateOrFn<TFFormData>,
TFOnChange extends undefined | FormValidateOrFn<TFFormData>,
TFOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFFormData>,
TFOnBlur extends undefined | FormValidateOrFn<TFFormData>,
TFOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFFormData>,
TFOnSubmit extends undefined | FormValidateOrFn<TFFormData>,
TFOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFFormData>,
TFOnServer extends undefined | FormValidateOrFn<TFFormData>,
TFSubmitMeta extends TSubmitMeta
>(props: {
value: TFFormData
formApi: FormApi<
TFormData,
TOnMount,
TOnChange,
TOnChangeAsync,
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync,
TOnServer,
TSubmitMeta
TFFormData,
TFOnMount,
TFOnChange,
TFOnChangeAsync,
TFOnBlur,
TFOnBlurAsync,
TFOnSubmit,
TFOnSubmitAsync,
TFOnServer,
TFSubmitMeta
>
}) => void
transform?: FormTransform<
NoInfer<TFormData>,
NoInfer<TOnMount>,
NoInfer<TOnChange>,
NoInfer<TOnChangeAsync>,
NoInfer<TOnBlur>,
NoInfer<TOnBlurAsync>,
NoInfer<TOnSubmit>,
NoInfer<TOnSubmitAsync>,
NoInfer<TOnServer>,
NoInfer<TSubmitMeta>
>
transform?: FormTransform<NoInfer<TFormData>>
}

/**
Expand Down