Getting Started

TypeDI is a dependency injection library for TypeScript and JavaScript.


Note: This installation guide is for usage with TypeScript, if you wish to use TypeDI without Typescript please read the getting started guide for JavaScript.

To start using TypeDI install the required packages via NPM:

npm install typedi reflect-metadata

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

import 'reflect-metadata';

// Your other imports and initialization code
// comes here after you imported the reflect-metadata package!

As the 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:

"emitDecoratorMetadata": true,
"experimentalDecorators": true,

Now you are ready to use TypeDI with Typescript!

Basic Usage

The most basic usage is to request an instance of a class definition. TypeDI will check if an instance of the class has been created before and return the cached version or it will create a new instance, cache, and return it.

import { Container, Service } from 'typedi';

class ExampleInjectedService {
  printMessage() {
    console.log('I am alive!');

class ExampleService {
    // because we annotated ExampleInjectedService with the @Service()
    // decorator TypeDI will automatically inject an instance of
    // ExampleInjectedService here when the ExampleService class is requested
    // from TypeDI.
    public injectedService: ExampleInjectedService
  ) {}

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

// logs "I am alive!" to the console

Last updated