feat: added ResetFormOpts arg to useResetForm closes #4707

Author: logaretm

.changeset/wise-schools-hammer.md

@@ -0,0 +1,5 @@
+---
+"vee-validate": patch
+---
+
+feat: added ResetFormOpts arg to useResetForm closes #4707

packages/vee-validate/src/useResetForm.ts

@@ -1,5 +1,5 @@
 import { FormContextKey } from './symbols';
-import { FormState } from './types';
+import { FormState, ResetFormOpts } from './types';
 import { injectWithSelf, warn } from './utils';
 
 export function useResetForm<TValues extends Record<string, unknown> = Record<string, unknown>>() {
@@ -10,11 +10,11 @@ export function useResetForm<TValues extends Record<string, unknown> = Record<st
     }
   }
 
-  return function resetForm(state?: Partial<FormState<TValues>>) {
+  return function resetForm(state?: Partial<FormState<TValues>>, opts?: ResetFormOpts) {
     if (!form) {
       return;
     }
 
-    return form.resetForm(state);
+    return form.resetForm(state, opts);
   };
 }

packages/vee-validate/tests/useResetForm.spec.ts

@@ -1,4 +1,4 @@
-import { useField, useForm, useResetForm } from '@/vee-validate';
+import { FormContext, useField, useForm, useResetForm } from '@/vee-validate';
 import { mountWithHoc, setValue, flushPromises } from './helpers';
 
 describe('useResetForm()', () => {
@@ -73,4 +73,30 @@ describe('useResetForm()', () => {
     expect(spy).toHaveBeenCalled();
     spy.mockRestore();
   });
+
+  test('resets a form with passed options', async () => {
+    let resetForm: any;
+    let form!: FormContext<{ fname: string; lname: string }>;
+
+    mountWithHoc({
+      setup() {
+        form = useForm({
+          initialValues: { fname: '123', lname: '456' },
+        });
+
+        resetForm = useResetForm();
+
+        return {};
+      },
+      template: `
+        <div></div>
+      `,
+    });
+
+    await flushPromises();
+
+    resetForm({ values: { fname: 'test' } }, { force: true });
+    expect(form.values.lname).toBeUndefined();
+    expect(form.values.fname).toBe('test');
+  });
 });