Noteworthy Programming Masterpiece
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

simple-js-di

1.1.1 • Public • Published

Build Status GitHub release (latest by date) GitHub last commit NPM

js-di

This is a pretty simple DI-container for ES6.

Install

$ npm install simple-js-di

A very simple example

import DI from "simple-js-di";
import FooClass from "./classes/FooClass";
 
let di = new DI();
di.add('foo', FooClass); // add FooClass as service named 'foo'
const foo = di.resolve('foo'); // get an instance of FooClass

One more example

import DI from "simple-js-di";
 
class Foo
{
    bar = null;
    constructor(bar) {
        this.bar = bar;
    }
 
    getGreeting() {
        return this.bar.greeting + '' + this.bar.name + '!';
    }
}
 
class Bar
{
    name = null;
    greeting = null;
    constructor(greeting, name) {
        this.greeting = greeting;
        this.name = name;
    }
}
 
let di = new DI();
di.add("foo", Foo, [":bar"]);
di.add("bar", Bar, ["Hello", "@name"]);
di.addParameters({
    'name': 'World',
});
const foo = di.resolve("foo");
 
console.log(foo.getGreeting()); // Hello, World!

For more examples see https://github.com/pilov-pa/js-di/tree/master/examples

Api

Using method add(name, value, dependencies, shared)

Adds new dependency to the container.

Example
di.add("someService", SomeServiceClass, [":anotherService", "@someParameter", 123], true);

or

di.add({
    name: "someService", 
    class: SomeServiceClass, 
    args: [":anotherService", "@someParameter", 123], 
    shared: true,
    tags: ["tag1", "tag2"],
});

Method add() has 5 arguments:

Argument name

This is an alias of the dependency that you should use to resolve it.

Argument className

This argument can be a class or a value. If it is a class then resolving returns the result of calls the class constructor.

Argument args

This argument is array of service dependencies should be pass to service constructor. All dependencies should be registered in the di-container. If dependency name has prefix @ then dependency is an another service. If dependency name has prefix : then dependency is a parameter. Otherwise, the dependency is the passed value as is. Default the empty array.

Argument shared

If this argument is false, each resolving will return a new instance of the class. If this argument is true, only the first resolving will create a new instance, the next calls will use the alredy created instance. Default true.

Argument tags

Tags list. See getByTag()

Using method resolve(name)

Resolving the dependency by the name. All subdependencies will be resolved automatically if necessary.

Method has only one argument: name.

Using method getByTag(tag)

Get all services tagged by tag

Install

npm i simple-js-di

DownloadsWeekly Downloads

167

Version

1.1.1

License

MIT

Unpacked Size

146 kB

Total Files

33

Last publish

Collaborators

  • avatar