di-injector
v1.0.54
Published
Javascript dependency injector
Downloads
6
Maintainers
Readme
di-injector is a DI injector using bindings, dependencies and injectors based on the Angular 2 DI system API simplified to make the job.
Current status
The project has been created on 22/07/15. You can run the test by using gulp test (note that some other tests will be added with time). The documentation is really small, just like the module and can be found in the ./documentation directory.
Installation
Launch the following command :
npm install di-injector
How to use it
The module comes with multiple injection possibilities like :
- Value injection
- Factory injection
- Class injection
How to inject ?
Create a new injector using the following binding :
/* Get the module dependencies */
var di = require('di-injector');
var Binding = di.Binding;
var Injector = di.Injector;
var MyClass = require('./MySuperClass'); // a javascript class with getAll method
/* Create a new injector */
var myInjector = Injector.resolveAndCreate([
// Using a new binding with toValue
new Binding('myValue', {toValue:2015}),
// Using a new binding with a factory
new Binding('myFactory', {toFactory:function(){
return 2015+1000;
]}),
// Using a class
new Binding('myClass', {toClass:MyClass})
]);
console.log(myInjector.get('myValue')); // prints 2015
console.log(myInjector.get('myFactory')); // prints 3015
/* Prints the MyClass getAll function result */
console.log(myInjector.get('myClass').getAll());
Using dependencies
You can use class dependencies, like setter, property and constructor injection.
Example:
var myInjector = Injector.resolveAndCreate([
new Binding('Class1', {toClass:Class1}),
new Binding('Class2',{toClass:Class2})
]);
// Class1 file
export class Class1{
constructor(class2){
this.class2 = class2;
}
}
Class1.diConstructor = ['Class2'];
//Class1.diSetter = ['Class2'];
//Class1.diProperty = ['Class2'];
You can inject classes or value or factory every where you want by precising the name of the binding you registered before / after in the list of your injector.
**/!\ Be careful, reflexive classes are not taken in care **
Using parent injectors
You can use parent injectors if needed. When you create a new injector, you have to pass the parent as the second parameter of the constructor call :
var myInjector = Injector.resolveAndCreate([/* My binding list ...*/], parentInjector)
Licence MIT
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.