change option to enableCircularCheck and disable circular check by default

Author: sheiidan

src/ClassTransformOptions.ts

@@ -58,8 +58,8 @@ export interface ClassTransformOptions {
 
 
     /**
-     * If set to true then class transformer will not perform a circular check.
-     * This option is useful when you know for sure that your types can't have a circular dependency. You usually use this option to boost the transform operation.
+     * If set to true then class transformer will perform a circular check. (circular check is turned off by default)
+     * This option is useful when you know for sure that your types might have a circular dependency.
      */
-    skipCircularCheck?: boolean;
+    enableCircularCheck?: boolean;
 }

src/TransformOperationExecutor.ts

@@ -36,7 +36,7 @@ export class TransformOperationExecutor {
             const newValue = arrayType && this.transformationType === "plainToClass" ? new (arrayType as any)() : [];
             (value as any[]).forEach((subValue, index) => {
                 const subSource = source ? source[index] : undefined;
-                if (this.options.skipCircularCheck || !this.isCircular(subValue, level)) {
+                if (!this.options.enableCircularCheck || !this.isCircular(subValue, level)) {
                     const value = this.transform(subSource, subValue, targetType, undefined, subValue instanceof Map, level + 1);
                     if (newValue instanceof Set) {
                         newValue.add(value);
@@ -157,7 +157,7 @@ export class TransformOperationExecutor {
                         continue;
                 }
 
-                if (this.options.skipCircularCheck || !this.isCircular(subValue, level)) {
+                if (!this.options.enableCircularCheck || !this.isCircular(subValue, level)) {
                     let transformKey = this.transformationType === "plainToClass" ? newValueKey : key;
                     let finalValue = this.transform(subSource, subValue, type, arrayType, isSubValueMap, level + 1);
                     finalValue = this.applyCustomTransformations(finalValue, targetType, transformKey);

test/functional/circular-reference-problem.spec.ts

@@ -40,7 +40,7 @@ describe("circular reference problem", () => {
         photo1.users = [user];
         photo2.users = [user];
 
-        const plainUser = classToPlain(user);
+        const plainUser = classToPlain(user, { enableCircularCheck: true });
         plainUser.should.be.eql({
             firstName: "Umed Khudoiberdiev",
             photos: [{
@@ -89,14 +89,14 @@ describe("circular reference problem", () => {
         photo1.users = [user];
         photo2.users = [user];
 
-        const classUser = classToClass(user);
+        const classUser = classToClass(user, { enableCircularCheck: true });
         classUser.should.not.be.equal(user);
         classUser.should.be.instanceOf(User);
         classUser.should.be.eql(user);
 
     });
 
-    describe("skipCircularCheck option", () => {
+    describe("enableCircularCheck option", () => {
         class Photo {
             id: number;
             filename: string;
@@ -124,14 +124,14 @@ describe("circular reference problem", () => {
             isCircularSpy.restore();
         });
 
-        it("skipCircularCheck option is true", () => {
-            const result = plainToClass<User, Object>(User, user, { skipCircularCheck: true}); 
+        it("enableCircularCheck option is undefined (default)", () => {
+            const result = plainToClass<User, Object>(User, user); 
             sinon.assert.notCalled(isCircularSpy);
         });
 
-        it("skipCircularCheck option is undefined", () => {
-            const result = plainToClass<User, Object>(User, user); 
+        it("enableCircularCheck option is true", () => {
+            const result = plainToClass<User, Object>(User, user, { enableCircularCheck: true }); 
             sinon.assert.called(isCircularSpy);
-        });        
+        });
     });
 });