TypeDI

Simple yet powerful dependency injection tool for JavaScript and TypeScript...

Dependency Injection
typestack/typedidocs.typestack.community/typedi/v/develop/01-getting-startedtypedi

README

TypeDI


Build Status
codecov
npm version
Dependency Status

TypeDI is a dependency injection tool for TypeScript and JavaScript. With it you can build well-structured and easily testable applications in Node or in the browser.

Main features includes:

- property based injection
- constructor based injection
- singleton and transient services
- support for multiple DI containers

Installation


Note: This installation guide is for usage with TypeScript, if you wish to use

TypeDI without Typescript please read the documentation about how get started.


To start using TypeDI install the required packages via NPM:

  1. ```bash
  2. npm install typedi reflect-metadata
  3. ```

Import the reflect-metadata package at the first line of your application:

  1. ```ts
  2. import 'reflect-metadata';

  4. // Your other imports and initialization code
  5. // comes here after you imported the reflect-metadata package!
  6. ```

As a last step, you need to enable emitting decorator metadata in your Typescript config. Add these two lines to your tsconfig.json file under the compilerOptions key:

  1. ```json
  2. "emitDecoratorMetadata": true,
  3. "experimentalDecorators": true,
  4. ```

Now you are ready to use TypeDI with Typescript!

Basic Usage


  1. ```ts
  2. import { Container, Service } from 'typedi';

  4. @Service()
  5. class ExampleInjectedService {
  6.   printMessage() {
  7.     console.log('I am alive!');
  8.   }
  9. }

  11. @Service()
  12. class ExampleService {
  13.   constructor(
  14.     // because we annotated ExampleInjectedService with the @Service()
  15.     // decorator TypeDI will automatically inject an instance of
  16.     // ExampleInjectedService here when the ExampleService class is requested
  17.     // from TypeDI.
  18.     private injectedService: ExampleInjectedService
  19.   ) {}
  20. }

  22. const serviceInstance = Container.get(ExampleService);
  23. // we request an instance of ExampleService from TypeDI

  25. serviceInstance.injectedService.printMessage();
  26. // logs "I am alive!" to the console
  27. ```

Documentation


The detailed usage guide and API documentation for the project can be found:

- at [docs.typestack.community/typedi][docs-stable]
- in the ./docs folder of the repository

[docs-stable]: https://docs.typestack.community/typedi/
[docs-development]: https://docs.typestack.community/typedi/v/develop/

Contributing


Please read our contributing guidelines to get started.