mobx-react-use-autorun 3.1.8 → 3.1.9

package/README.md

@@ -6,7 +6,7 @@ Provide concise usage for mobx in react<br/>
 
 # `Usage`
 
-### Usage - Define state and props with useMobxState
+### Define state and props with useMobxState
 
     import { useMobxState, observer } from 'mobx-react-use-autorun';
     import { useRef } from 'react';
@@ -110,7 +110,7 @@ The second:
 
 Provide a method to generate state, the state is executed only once, and the performance is better.<br/>
 
-### Usage - Subscription property changes with useMobxEffect
+### Subscription property changes with useMobxEffect
 
     import { useMobxState, observer } from 'mobx-react-use-autorun';
     import { useMobxEffect, toJS } from 'mobx-react-use-autorun'
@@ -128,7 +128,37 @@ Provide a method to generate state, the state is executed only once, and the per
         </div>
     })
 
-### Usage - Get the real data of the proxy object with toJS
+### Lifecycle hooks
+
+useMount is executed when the component loaded.<br/>
+useUnmount is executed when the component is unmount.<br/>
+
+    import { Subscription, of, tap } from 'rxjs'
+    import { useMobxState, observer } from 'mobx-react-use-autorun'
+    import { useMount, useUnmount } from 'mobx-react-use-autorun'
+
+    export default observer(() => {
+
+        const state = useMobxState({
+            subscription: new Subscription()
+        })
+
+        useMount(() => {
+            state.subscription.add(of(null).pipe(
+                tap(() => {
+                    console.log('component is loaded')
+                })
+            ).subscribe())
+        })
+
+        useUnmount(() => {
+            state.subscription.unsubscribe()
+        })
+
+        return null;
+    })
+
+### Get the real data of the proxy object with toJS
 
 toJS will cause data to be used, please do not execute toJS(state) in component rendering code, it may cause repeated rendering.<br/>
 Wrong Usage Demonstration:<br/>
@@ -169,7 +199,7 @@ Correct Example:<br/>
         return <button onClick={() => console.log(toJS(state))}>{'Click Me'}</button>;
     })
 
-### Usage - Define global mutable data with observable
+### Define global mutable data with observable
 
     import { observable } from 'mobx-react-use-autorun';
 
@@ -195,36 +225,6 @@ Correct Example:<br/>
         </div>;
     })
 
-### Usage - Lifecycle hooks
-
-useMount is executed when the component loaded.<br/>
-useUnmount is executed when the component is unmount.<br/>
-
-    import { Subscription, of, tap } from 'rxjs'
-    import { useMobxState, observer } from 'mobx-react-use-autorun'
-    import { useMount, useUnmount } from 'mobx-react-use-autorun'
-
-    export default observer(() => {
-
-        const state = useMobxState({
-            subscription: new Subscription()
-        })
-
-        useMount(() => {
-            state.subscription.add(of(null).pipe(
-                tap(() => {
-                    console.log('component is loaded')
-                })
-            ).subscribe())
-        })
-
-        useUnmount(() => {
-            state.subscription.unsubscribe()
-        })
-
-        return null;
-    })
-
 # Learn More
 
 1. React UI framework (https://reactjs.org)<br/>

package/package.json

@@ -1 +1 @@
-{"name":"mobx-react-use-autorun","version":"3.1.8","description":"React Hook for mobx","scripts":{"test":"npx -y -p typescript -p ts-node ts-node --skipProject bin/mobx_react_test.ts","build":"npx -y -p typescript -p ts-node ts-node --skipProject bin/mobx_react_build.ts","make":"npx -y -p typescript -p ts-node ts-node --skipProject bin/mobx_react_make.ts"},"dependencies":{"mobx":"6.8.0","mobx-react-lite":"3.4.0","react-use":"17.4.0","rxjs":"7.8.0"},"peerDependencies":{"react":">=16.8.0"},"license":"MIT","keywords":["react","mobx","typescript"],"main":"./dist/index.js","types":"./dist/index.d.ts","eslintConfig":{"extends":["react-app","react-app/jest"]},"homepage":"https://github.com/zdu-strong/mobx-react-use-autorun#readme","repository":{"type":"git","url":"git+https://github.com/zdu-strong/mobx-react-use-autorun.git"},"files":["lib","dist"],"bugs":{"url":"https://github.com/zdu-strong/mobx-react-use-autorun/issues"},"publishConfig":{"registry":"https://registry.npmjs.org/"}}
+{"name":"mobx-react-use-autorun","version":"3.1.9","description":"React Hook for mobx","scripts":{"test":"npx -y -p typescript -p ts-node ts-node --skipProject bin/mobx_react_test.ts","build":"npx -y -p typescript -p ts-node ts-node --skipProject bin/mobx_react_build.ts","make":"npx -y -p typescript -p ts-node ts-node --skipProject bin/mobx_react_make.ts"},"dependencies":{"mobx":"6.8.0","mobx-react-lite":"3.4.0","react-use":"17.4.0","rxjs":"7.8.0"},"peerDependencies":{"react":">=16.8.0"},"license":"MIT","keywords":["react","mobx","typescript"],"main":"./dist/index.js","types":"./dist/index.d.ts","eslintConfig":{"extends":["react-app","react-app/jest"]},"homepage":"https://github.com/zdu-strong/mobx-react-use-autorun#readme","repository":{"type":"git","url":"git+https://github.com/zdu-strong/mobx-react-use-autorun.git"},"files":["lib","dist"],"bugs":{"url":"https://github.com/zdu-strong/mobx-react-use-autorun/issues"},"publishConfig":{"registry":"https://registry.npmjs.org/"}}