fabric 6.0.1 → 6.0.2

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [next]
 
+## [6.0.2]
+
+- fix(TS): Type fixes and improved JSDOCS. [#9978](https://github.com/fabricjs/fabric.js/pull/9978)
+
+## [6.0.1]
+
 - chore(): export InteractiveFabricObject to tweak default values [#9963](https://github.com/fabricjs/fabric.js/pull/9963)
 - chore(): use deconstruction and constants in place of strings to save some bytes of code [#9593](https://github.com/fabricjs/fabric.js/pull/9593)
 - tests(): Start moving visual tests to playwrigth [#9481](https://github.com/fabricjs/fabric.js/pull/9481)

package/dist/index.js

@@ -407,7 +407,7 @@
   }
   const cache = new Cache();
 
-  var version = "6.0.1";
+  var version = "6.0.2";
 
   // use this syntax so babel plugin see this import here
   const VERSION = version;
@@ -635,6 +635,14 @@
       }
     }
 
+    /**
+     * Unsubscribe all event listeners for eventname.
+     * Do not use this pattern. You could kill internal fabricJS events.
+     * We know we should have protected events for internal flows, but we don't have yet
+     * @deprecated
+     * @param {string} eventName event name (eg. 'after:render')
+     */
+
     /**
      * unsubscribe an event listener
      * @param {string} eventName event name (eg. 'after:render')
@@ -1893,6 +1901,7 @@
     });
   };
   /**
+   * @TODO type this correctly.
    * Creates corresponding fabric instances from their object representations
    * @param {Object[]} objects Objects to enliven
    * @param {EnlivenObjectOptions} [options]
@@ -6969,18 +6978,20 @@
     }
 
     /**
-     * The class type. Used to identify which class this is.
-     * This is used for serialization purposes and internally it can be used
-     * to identify classes. As a developer you could use `instance of Class`
-     * but to avoid importing all the code and blocking tree shaking we try
-     * to avoid doing that.
+     * The class type.
+     * This is used for serialization and deserialization purposes and internally it can be used
+     * to identify classes.
+     * When we transform a class in a plain JS object we need a way to recognize which class it was,
+     * and the type is the way we do that. It has no other purposes and you should not give one.
+     * Hard to reach on instances and please do not use to drive instance's logic (this.constructor.type).
+     * To idenfity a class use instanceof class ( instanceof Rect ).
+     * We do not do that in fabricJS code because we want to try to have code splitting possible.
      */
 
     /**
      * Legacy identifier of the class. Prefer using utils like isType or instanceOf
      * Will be removed in fabric 7 or 8.
-     * The setter exists because is very hard to catch all the ways in which a type value
-     * could be set in the instance
+     * The setter exists to avoid type errors in old code and possibly current deserialization code.
      * @TODO add sustainable warning message
      * @type string
      * @deprecated