https://github.com/opentable/injecorator
A simple decorator based dependecy injection framework for nodejs es6 projects
https://github.com/opentable/injecorator
Last synced: 3 months ago
JSON representation
A simple decorator based dependecy injection framework for nodejs es6 projects
- Host: GitHub
- URL: https://github.com/opentable/injecorator
- Owner: opentable
- License: mit
- Created: 2016-04-15T04:45:07.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-06-09T04:46:49.000Z (almost 9 years ago)
- Last Synced: 2025-03-04T00:08:34.327Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 23
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Injecorator
===================
A simple decorator based dependecy injection framework for nodejs es6 projects
[](http://badge.fury.io/js/injecorator)
[](https://travis-ci.org/injecorator/spur-ioc)
## Installation
```bash
$ npm install injecorator --save
```
## Usage
usage requiring [babel-plugin-transform-decorators-legacy](https://github.com/loganfsmyth/babel-plugin-transform-decorators-legacy) with babel 6
```javascript
import {Inject, IocContainer } from 'injecorator';
const staticObject = { staticdep: true };
@Inject(staticObject)
class One
{
constructor(staticOb){
this.static = staticOb;
this.isReallyOne = true;
}
}
@Inject(staticObject, One)
class Two
{
constructor(staticOb, oneCls){
this.static = staticOb;
this.one = oneCls;
this.isReallyTwo = true;
}
}
const ioc = new IocContainer();
ioc.regAll(staticObject, One, Two);
const two = ioc.get(Two);
console.log(two);
```
Without using javascript decorators set a static property $inject on the object that contains an array of dependencies
```javascript
class Three
{
constructor(two){
this.two = two;
this.isReallyThree = true;
}
}
Three.$inject = [Two];
```
Registering an extension or replacement dependency
```javascript
const ioc = new IocContainer();
ioc.regAll(staticObject, Two);
ioc.register(One, { isReallyOne: false });
const two = ioc.get(Two);
expect(two.one.isReallyOne).to.be.equal(false);
```
Registering a factory method as a value provider. The argument passed to this method is an instance of the ioc container
```javascript
class OneDerived extends One
{
constructor(staticOb){
super(staticOb);
this.isDerivedOne = true;
}
}
const ioc = new IocContainer();
ioc.register(OneDerived);
ioc.register(One, (iocArg) => iocArg.get(OneDerived));
const one = ioc.get(One);
expect(one.isReallyOne && one.isDerivedOne).to.be.equal(true);
```