depenject

depenject is a lightweight and fast IoC container to resolve dependencies, achieving Inversion of Control (IoC) between their dependencies.

Installing

For the latest stable version:

npm install depenject

Contribute

There are many ways to contribute to depenject:

• Submit bugs and help us verify fixes as they are checked in.
• Review the source code changes.
• Contribute bug fixes.

Documentation

• Overview of dependency injection with depenject

Building

In order to build the depenject, ensure that you have Git and Node.js installed.

Clone a copy of the repo:

git clone https://github.com/rodrigo-speller/depenject.git

Change to the depenject directory:

cd depenject

Install tools and dev dependencies:

npm install

Use one of the following to build and test:

npm run build       # Build the library into "dist" directory.
npm run test        # Test the library code.
npm run coverage    # Generates the coverage from the tests.

A simple sample to copy-and-paste

// name-provider.ts

import { resolver } from 'depenject';

export default class NameProvider {
  public name: string = "World";

  static [resolver]() {
    return new NameProvider();
  }
}

// hello-service.ts

import { Container, resolver } from 'depenject';

import NameProvider from './name-provider';

export default class HelloService {
  private nameProvider: NameProvider;

  constructor(nameProvider: NameProvider) {
    this.nameProvider = nameProvider;
  }

  static [resolver](container: Container) {
    return new HelloService(container.resolve(NameProvider));
  }

  sayHello() {
    console.log("Hello " + this.nameProvider.name + "!");
  }
}

// hello.ts

import { Container, ContainerBuilder, resolver } from 'depenject';
import NameProvider from './name-provider';
import HelloService from './hello-service';

let container = new ContainerBuilder()
  .register(HelloService)
  .registerSingleton(NameProvider)
  .build();

// resolve dependencies

let helloService = container.resolve(HelloService);
let nameProvider = container.resolve(NameProvider);

// execution

helloService.sayHello();
nameProvider.name = "Rodrigo Speller"
helloService.sayHello();

The hello sample outputs the below text in console:

Hello World!
Hello Rodrigo Speller!

License

Copyright 2019 Rodrigo Speller

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.