inverter-ioc/README.md

Just an ioc container made in javascript

# inverter-ioc

Just a fast, tiny and useful IoC container made in Javascript

  [![NPM Version][npm-image]][npm-url]
  [![NPM Downloads][downloads-image]][downloads-url]
  [![Linux Build][travis-image]][travis-url]
  [![Coverage][coverage-image]][coverage-url]

## Installation

```bash
$ npm install inverter-ioc
```

## Quick Start

```js
// Importing the module.
let inverter = import('inverter-ioc');

// Registering the current instance for future use.
inverter.register("registerName", YourClassName);

// Calling a previously created instance.
let resolvedInstance = inverter.resolve("registerName", YourClassName);
```

## Real World Example
```js
// Registering Constants
inverter.register('Constants', function() {
  this.pi = 3.14159;
  return this;
});

// Registering the circle class, using a previously registred function
inverter.register('Circle', function(Constants) {
    this.area = function(radius) {
        return Constants.pi * radius * radius;
    };
    this.getPi = function () {
      return Constants.pi;
    }
    return this;
});

// Resolving the cicle instance
var circle = inverter.resolve('Circle');

// Using the instance
console.log(circle.area(2));
console.log(circle.getPi());
```
## Tests

  To run the test suite, first install the dependencies, then run `npm test`:

```bash
$ npm install
$ npm test
```
  To analyze the code coverage status, install all dependencies and run `npm run coverage`:

```bash
$ npm install
$ npm run coverage
```
## Features

  * Upcoming

## License

  [GNU GENERAL PUBLIC LICENSE](LICENSE)

[npm-image]: https://img.shields.io/npm/v/inverter-ioc.svg
[npm-url]: https://npmjs.org/package/inverter-ioc
[downloads-image]: https://img.shields.io/npm/dm/inverter-ioc.svg
[downloads-url]: https://npmjs.org/package/inverter-ioc
[coverage-url]: https://coveralls.io/github/felipeuntill/inverter-ioc?branch=master
[travis-image]: https://travis-ci.org/felipeuntill/inverter-ioc.svg
[coverage-image]: https://coveralls.io/repos/github/felipeuntill/inverter-ioc/badge.svg?branch=master
[travis-url]: https://travis-ci.org/felipeuntill/inverter-ioc