This package is a wrapper of Inversify to simplify how inject your dependencies with property decorators in the components, made with TypeScript and compatible with Vue, React and other component libraries.
Do you use Hooks? You can try the experimental package inversify-hooks
$ npm install inversify-props reflect-metadata --save
The inversify-props type definitions are included in the inversify-props npm package.
How to use
; // Import only once;container.addSingletonService1;container.addSingletonService2;container.addSingletonService3;
How to use this library outside of a component
; // Import only once;container.addSingletonService1, 'MyService1';// You can inject in other services as a Prop// Also in the constructor as a param// Or in any function as a variable// camelCase, PascalCase and _ are allowed
You can also use any ID that you prefer if you don't want to use auto generated ids
; // Import only once;container.addSingletonService1, 'MyService1';
This library provides a container to make your experience easier, but you can create your own container.
; // Import only once;setContainernew Container;container.addSingletonService1, 'MyService1';
⚠️ Important! inversify-props requires TypeScript >= 2.0 and the
libcompilation options in your
Why we made this package
The idea is to add a simple wrapper that helps us to inject dependencies in components using
property decorators, we have also extend a little
inversify adding some methods that make our experience injecting dependencies easier.
You probably don't need this if:
- You have experience using inversify and you don't need to simplify the process.
- You want to use all the power of inversify, we are only injecting dependencies like services, helpers, utils...
- You don't want to inject your dependencies as properties.
How to register a dependency
Inversify needs an id to register our dependencies, this wrapper is going to do this for you 'magically' but if you want to uglify the code, keep reading the docs 🤓.
First of all create a class and an interface with the public methods of your class.
// iservice1.ts// service.ts
Now is time to register the service in the container, we usually do that in
How to test
There are some helper functions to test, the recommended way to test is beforeEach test:
- Reset the Container
- Register again all the dependencies of the container (this is your job)
- Mock all the necessary dependencies for the test
Other ways to register a class
As inversify accepts, we have configured three types of registration.
- Singleton: The dependency will be created only once, one dependency - one object.
- Transient: The dependency will be created each time is injected, one dependency - one object per injection.
- Request: Special case of singleton, more info in official docs.
How to use in your components
Once your dependencies are registered in the container, is simple as create a property with the name and the interface.
Note: Part of the magic is that the name of the property has to be the name of the interface, this is how we don't need to add the
How to configure Uglify or Terser
If you want to use Uglify or Terser to obfuscate the code, you will need to add this options to preserve the names of the classes (we need them to generate the ids