inversify-hooks - npm Package Compare versions

Comparing version 1.3.2 to 1.3.6

package.json

 {
   "name": "inversify-hooks",
-  "version": "1.3.2",
+  "version": "1.3.6",
   "description": "Wrapper of inversify-props to inject your dependencies in the components, made with TypeScript using hooks.",
@@ -26,4 +26,4 @@ "main": "dist/index.js",
   "dependencies": {
-    "inversify-props": "^1.3.0"
+    "inversify-props": "^1.3.6"
   }
 }

README.md

@@ -19,2 +19,27 @@ # Inversify Hooks
 
+## How to use
+```
+import 'reflect-metadata'; // Import only once
+import { container, useContainer } from 'inversify-hooks';
+
+container.addSingleton<IService1>(Service1);
+
+function ExampleComponent() {
+  const service1 = useContainer<IService1>(cid.IService1);
+  
+  useEffect(() => {
+    service1.asyncMethod();
+  }, [])
+}
+```
+
+## You can also use any ID that you prefer
+```
+container.addSingleton<IService1>(Service1, 'MyService1');
+
+function ExampleComponent() {
+  const service1 = useContainer<IService1>('MyService1');
+}
+```
+
 > :warning: **Important!** inversify-hooks requires TypeScript >= 2.0 and the `experimentalDecorators`, `emitDecoratorMetadata`, `types` and `lib`
@@ -35,21 +60,7 @@ compilation options in your `tsconfig.json` file.
 }
-
-## Usage
 ```
-container.addSingleton<IService1>(Service1);
 
-function ExampleComponent() {
-  const service1 = useContainer<IService1>(cid.IService1);
-}
-```
+## More examples
+There are more examples of how to use the container in services or other components in [inversify-props](https://github.com/ckgrafico/inversify-props#how-to-use)
 
-## You can also use any ID that you prefer
-```
-container.addSingleton<IService1>(Service1, 'MyService1');
-
-function ExampleComponent() {
-  const service1 = useContainer<IService1>('MyService1');
-}
-```
-
 ## Why we made this package
@@ -56,0 +67,0 @@ You can learn more about why we made this packages in the [original repo](https://github.com/ckgrafico/inversify-props#why-we-made-this-package).

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

6558

increased by5.74%

Number of lines in readme file

72

increased by18.03%

Dependency changes

• Updatedinversify-props@^1.3.6