react-aptor - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

esm/useAptor.d.ts

@@ -11,3 +11,3 @@ import { RefObject, Ref } from 'react';
     instantiate: Instantiate<T>;
-    destroy: Destroy<T>;
+    destroy?: Destroy<T>;
     params?: any;
@@ -14,0 +14,0 @@ }

esm/useAptor.js

@@ -17,3 +17,2 @@ import { useEffect, useImperativeHandle, useState, useRef, useMemo } from 'react';
         setInstance(instanceReference);
-        // eslint-disable-next-line react-hooks/exhaustive-deps
         return function () {
@@ -23,2 +22,3 @@ if (destroy)
         };
+        // eslint-disable-next-line react-hooks/exhaustive-deps
     }, deps);
@@ -25,0 +25,0 @@ // eslint-disable-next-line react-hooks/exhaustive-deps

lib/useAptor.d.ts

@@ -11,3 +11,3 @@ import { RefObject, Ref } from 'react';
     instantiate: Instantiate<T>;
-    destroy: Destroy<T>;
+    destroy?: Destroy<T>;
     params?: any;
@@ -14,0 +14,0 @@ }

lib/useAptor.js

@@ -19,3 +19,2 @@ "use strict";
         setInstance(instanceReference);
-        // eslint-disable-next-line react-hooks/exhaustive-deps
         return function () {
@@ -25,2 +24,3 @@ if (destroy)
         };
+        // eslint-disable-next-line react-hooks/exhaustive-deps
     }, deps);
@@ -27,0 +27,0 @@ // eslint-disable-next-line react-hooks/exhaustive-deps

package.json

 {
   "name": "react-aptor",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "private": false,
@@ -5,0 +5,0 @@ "description": "React API connector",

README.md

@@ -12,4 +12,7 @@ <h1 align="center">React Aptor</h1>
   <a href="https://bundlephobia.com/result?p=react-aptor">
-    <img src="https://img.shields.io/bundlephobia/minzip/react-aptor.svg" alt="downloads" />
+    <img src="https://img.shields.io/bundlephobia/minzip/react-aptor.svg" alt="bundle size" />
 </a>
+  <a href="https://lgtm.com/projects/g/amirHossein-Ebrahimi/react-aptor/context:javascript">
+    <img src="https://img.shields.io/lgtm/grade/javascript/g/amirHossein-Ebrahimi/react-aptor.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" />
+</a>
 </p>
@@ -22,4 +25,8 @@
 </p>
+
 Don’t waste your time by finding react version of your favorite javascript package, keep control of your `API` now.
 
+**Documentation**: You can find the react-aptor documentation [on the website](https://ahimico.github.io/docs/react-aptor/tutorials-overview).
+
+
 ## Why
@@ -32,8 +39,11 @@
 
-**Concerns**:
+If you are still not convinced you can read this [article](https://dev.to/amirhe/aptor-is-all-you-need-3din)
 
-- on finding DOM nodes by `ReactDOM.findDOMNode`
+
+**Other Concerns**:
+- Finding DOM nodes by ReactDOM.findDOMNode
 - Extensively usage of memorization to improve performance or prevent extra re-renders
-- Other duplication layer for all API definition in react that increase the project size.
-- Rely on a global scope (e.g. window) for internal setting (making it impossible to have more than one instance).
+- Other duplication layer for all API definition in react that increase the project size
+- Rely on a global scope (e.g. window) for internal settings (making it impossible to have more than one instance)
+- backward compatible updates of the base package need another update for react-* package
 
@@ -346,2 +356,5 @@ ## react-aptor
 
+**NOTE**: Add your favourite packge do the following list by creating a [new issue](https://github.com/amirHossein-Ebrahimi/react-aptor/issues).
+
+
 ### [Quill.js](https://github.com/quilljs/quill) + `typescript`
@@ -353,3 +366,3 @@
 
-> Fabric.js is a powerful and simple. Javascript HTML5 canvas library. <img src="https://img.shields.io/github/stars/fabricjs/fabric.js?style=social" /> > <a href="https://codesandbox.io/s/react-aptor--fabric-hp50c"><img src="https://codesandbox.io/static/img/play-codesandbox.svg"></a>
+> Fabric.js is a powerful and simple. Javascript HTML5 canvas library. <img src="https://img.shields.io/github/stars/fabricjs/fabric.js?style=social" /> > <a href="https://codesandbox.io/s/re act-aptor--fabric-hp50c"><img src="https://codesandbox.io/static/img/play-codesandbox.svg"></a>
 
@@ -356,0 +369,0 @@ ### [Rive.js](https://rive.app)

src/useAptor.ts

@@ -16,3 +16,3 @@ import { useEffect, useImperativeHandle, useState, useRef, RefObject, useMemo, Ref } from 'react';
   instantiate: Instantiate<T>;
-  destroy: Destroy<T>;
+  destroy?: Destroy<T>;
   params?: any;
@@ -19,0 +19,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23327

increased by3.34%

Number of lines in readme file

379

increased by3.55%

No dependency changes