https://github.com/tanem/infector

:syringe: Dependency injection for Node.js and the browser.
https://github.com/tanem/infector

Last synced: 8 days ago
JSON representation

:syringe: Dependency injection for Node.js and the browser.

• Host: GitHub
• URL: https://github.com/tanem/infector
• Owner: tanem
• License: mit
• Created: 2013-09-10T20:46:21.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2020-07-15T20:00:50.000Z (over 4 years ago)
• Last Synced: 2024-04-25T06:01:06.490Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 67.4 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Infector

[![build status](https://img.shields.io/travis/tanem/infector/master.svg?style=flat-square)](https://travis-ci.org/tanem/infector)

[![coverage status](https://img.shields.io/coveralls/tanem/infector.svg?style=flat-square)](https://coveralls.io/r/tanem/infector)

[![npm version](https://img.shields.io/npm/v/infector.svg?style=flat-square)](https://www.npmjs.com/package/infector)

[![npm downloads](https://img.shields.io/npm/dm/infector.svg?style=flat-square)](https://www.npmjs.com/package/infector)

[![dependency status](https://david-dm.org/tanem/infector.svg?style=flat-square)](https://david-dm.org/tanem/infector)

[![devDependency status](https://david-dm.org/tanem/infector/dev-status.svg?style=flat-square)](https://david-dm.org/tanem/infector#info=devDependencies)

[![browser support](https://ci.testling.com/tanem/infector.png)](https://ci.testling.com/tanem/infector)

Dependency injection for Node.js and the browser. Inspired by the dependency injection approaches in [AngularJS](https://github.com/angular/angular.js) and [node-di](https://github.com/vojtajina/node-di). No relation to [Infector++](https://code.google.com/p/infectorpp/).

## Usage

### Grab `Infector`

In the browser, [Lo-Dash](http://lodash.com/) is a dependency and `Infector` is exposed as a global. So do something like:

```html

```

Using [Bower](http://bower.io/):

```

$ bower install infector --save

```

In Node.js:

```

$ npm install infector --save

```

### Specify dependencies

Use a constructor property:

```js

function Foo(bar) {}

Foo.infect = ['bar'];

// or Foo.inject = ['bar'];

```

### Register modules

There are two return options.

 * `type`: an instance of `type` will be returned via `new`:

```js

function Foo() {}

infector.register({ foo: { type: Foo } });

```

If you want the module to be returned as a singleton:

```js

infector.register({ foo: { type: Foo, isSingleton: true } });

```

 * `value`: the registered `value` will be returned:

```js

infector.register({ foo: { value: 'Foo' } });

```

### Get modules

Just do:

```js

infector.get('foo');

```

## Examples

### Browser

A working example is available in the `examples/browser` dir. To view:

```

$ open examples/browser/index.html

```

### Node.js

A working example is available in the `examples/node` dir. To run:

```

$ node examples/node

```

## Testing

In the browser:

```

$ npm run test-browser

```

In Node.js:

```

$ npm run test-spec

```

To generate a coverage report:

```

$ npm run test-cov

```

## Credits

 * This great article by Chad Perry: [DIY-DI](http://blacksheep.parry.org/wp-content/uploads/2010/03/DIY-DI.pdf)

 * [@vojtajina](https://github.com/vojtajina), whose injector recipe in [node-di](https://github.com/vojtajina/node-di) gave me ideas for module registration

 * [AngularJS](https://github.com/angular/angular.js), where the idea of [how to specify dependencies to be injected](http://docs.angularjs.org/guide/di) came from

 * [Infector++](https://code.google.com/p/infectorpp/), where the name for this component came from ;)