Merge pull request #26 from Luukkasz/isFormFieldValueUpdated

add isFormFieldValueUpdated function

DOCS.md

@@ -5,6 +5,8 @@
 <dd><p>Indicates if passed value is Form object.</p></dd>
 <dt><a href="#isFormFieldUpdated">isFormFieldUpdated(ff1, ff2)</a> ⇒ <code>boolean</code></dt>
 <dd><p>Indicates if FormField's value or error has changed.</p></dd>
+<dt><a href="#isFormFieldValueUpdated">isFormFieldValueUpdated(ff1, ff2)</a> ⇒ <code>boolean</code></dt>
+<dd><p>Indicates if FormField's value has changed.</p></dd>
 <dt><a href="#isFormField">isFormField(field)</a> ⇒ <code>boolean</code></dt>
 <dd><p>Indicates if passed param is FormField object.</p></dd>
 <dt><a href="#createFormField">createFormField(val, [validators], [noValidate])</a> ⇒ <code>FormField</code></dt>
@@ -56,6 +58,18 @@
 | ff1 | <code>FormField</code> | <p>First FormField.</p> |
 | ff2 | <code>FormField</code> | <p>Second FormField.</p> |
 
+<a name="isFormFieldValueUpdated"></a>
+
+## isFormFieldValueUpdated(ff1, ff2) ⇒ <code>boolean</code>
+<p>Indicates if FormField's value has changed.</p>
+
+**Kind**: global function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ff1 | <code>FormField</code> | <p>First FormField.</p> |
+| ff2 | <code>FormField</code> | <p>Second FormField.</p> |
+
 <a name="isFormField"></a>
 
 ## isFormField(field) ⇒ <code>boolean</code>

lib/form-utils.ts

@@ -36,6 +36,16 @@ export function isFormFieldUpdated<T>(ff1: FormField<T>, ff2: FormField<T>): boo
   return ff1.val !== ff2.val || ff1.err !== ff2.err
 }
 
+/**
+ * Indicates if FormField's value has changed.
+ * @param {FormField} ff1 - First FormField.
+ * @param {FormField} ff2 - Second FormField.
+ * @returns {boolean}
+ */
+export function isFormFieldValueUpdated<T>(ff1: FormField<T>, ff2: FormField<T>): boolean {
+  return ff1.val !== ff2.val
+}
+
 /**
  * Indicates if passed param is FormField object.
  * @param {any} field - Field to check.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@currency-one/form-utils",
-  "version": "1.0.10",
+  "version": "1.0.13",
   "description": "Form utils",
   "keywords": [
     "form-utils",

test/form-utils.spec.ts

@@ -4,7 +4,7 @@ import {
   createFormField,
   createPasswordFormField,
   formFieldsToValues, isForm,
-  isFormField,
+  isFormField, isFormFieldValueUpdated,
 } from '../lib/form-utils'
 
 describe('form-utils', () => {
@@ -118,4 +118,30 @@ describe('form-utils', () => {
     expect(formUpdated.field5.val).toBeTruthy()
     expect(formUpdated.field5.touched).toBeTruthy()
   })
+
+  it('should isFormFieldValueUpdated() return correct value', () => {
+    const formField1 = createFormField('')
+    const formField2 = createFormField('test')
+    const formField3 = createFormField(false)
+    const formField4 = createFormField(true)
+    const formField5 = createFormField(0)
+    const formField6 = createFormField(1)
+    const formField7 = createFormField({test: ''})
+    const formField8 = createFormField({test: 'test'})
+    const formField9 = createFormField('errorTest')
+    const formField10 = createFormField('errorTest')
+    formField10.err = 'error'
+
+    expect(isFormFieldValueUpdated(formField1, formField1)).toBe(false)
+    expect(isFormFieldValueUpdated(formField3, formField3)).toBe(false)
+    expect(isFormFieldValueUpdated(formField5, formField5)).toBe(false)
+    expect(isFormFieldValueUpdated(formField7, formField7)).toBe(false)
+
+    expect(isFormFieldValueUpdated(formField1, formField2)).toBe(true)
+    expect(isFormFieldValueUpdated(formField3, formField4)).toBe(true)
+    expect(isFormFieldValueUpdated(formField5, formField6)).toBe(true)
+    expect(isFormFieldValueUpdated(formField7, formField8)).toBe(true)
+
+    expect(isFormFieldValueUpdated(formField9, formField10)).toBe(false)
+  })
 })