full ts support

HISTORY.md

@@ -1,6 +1,11 @@
 # History
 ----
 
+## 4.0.0 / 2021-08-11
+
+- full ts support
+- support return transformed value when pass validation(promise and callback): https://github.com/yiminghe/async-validator/pull/277
+
 ## 3.5.0 / 2020-11-12
 
 - https://github.com/yiminghe/async-validator/pull/256/files

README.md

@@ -300,7 +300,7 @@ Note that `defaultField` is expanded to `fields`, see [deep rules](#deep-rules).
 
 #### Transform
 
-Sometimes it is necessary to transform a value before validation, possibly to coerce the value or to sanitize it in some way. To do this add a `transform` function to the validation rule. The property is transformed prior to validation and re-assigned to the source object to mutate the value of the property in place.
+Sometimes it is necessary to transform a value before validation, possibly to coerce the value or to sanitize it in some way. To do this add a `transform` function to the validation rule. The property is transformed prior to validation and returned as promise result or callback result when pass validation.
 
 ```js
 import Schema from 'async-validator';
@@ -316,8 +316,13 @@ const descriptor = {
 };
 const validator = new Schema(descriptor);
 const source = { name: ' user  ' };
+
 validator.validate(source)
-  .then(() => assert.equal(source.name, 'user'));
+  .then((data) => assert.equal(data.name, 'user'));
+
+validator.validate(source,(errors, data)=>{
+  assert.equal(data.name, 'user'));
+});
 ```
 
 Without the `transform` function validation would fail due to the pattern not matching as the input contains leading and trailing whitespace, but by adding the transform function validation passes and the field value is sanitized at the same time.

__tests__/any.spec.js → __tests__/any.spec.ts

@@ -1,4 +1,4 @@
-import Schema from '../src/';
+import Schema from '../src';
 
 const testNoErrorsFor = value => done => {
   new Schema({

__tests__/array.spec.js → __tests__/array.spec.ts

@@ -1,4 +1,4 @@
-import Schema from '../src/';
+import Schema from '../src';
 
 describe('array', () => {
   it('works for type', done => {
@@ -28,8 +28,19 @@ describe('array', () => {
       {
         v: '',
       },
-      errors => {
+      (errors, fields) => {
         expect(errors.length).toBe(1);
+        expect(fields).toMatchInlineSnapshot(`
+          Object {
+            "v": Array [
+              Object {
+                "field": "v",
+                "fieldValue": "",
+                "message": "v is not an array",
+              },
+            ],
+          }
+        `);
         expect(errors[0].message).toBe('v is not an array');
         done();
       },

__tests__/date.spec.js → __tests__/date.spec.ts

@@ -1,4 +1,4 @@
-import Schema from '../src/';
+import Schema from '../src';
 
 describe('date', () => {
   it('required works for undefined', done => {