Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/typestack/typedi
Simple yet powerful dependency injection tool for JavaScript and TypeScript.
https://github.com/typestack/typedi
dependency-injection inversion-of-control ioc typedi typescript
Last synced: 4 days ago
JSON representation
Simple yet powerful dependency injection tool for JavaScript and TypeScript.
- Host: GitHub
- URL: https://github.com/typestack/typedi
- Owner: typestack
- License: mit
- Created: 2015-09-29T12:23:30.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-29T09:19:48.000Z (2 months ago)
- Last Synced: 2024-10-29T15:06:46.975Z (2 months ago)
- Topics: dependency-injection, inversion-of-control, ioc, typedi, typescript
- Language: TypeScript
- Homepage: https://docs.typestack.community/typedi/v/develop/01-getting-started
- Size: 3.53 MB
- Stars: 4,056
- Watchers: 32
- Forks: 168
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - typedi - Simple yet powerful dependency injection tool for JavaScript and TypeScript. (TypeScript)
- awesome-github-star - typedi
- awesome-list - typedi
- awesome-star-libs - typestack / typedi
README
# TypeDI
[](https://codecov.io/gh/typestack/typedi)
[](https://badge.fury.io/js/typedi)
[](https://david-dm.org/typestack/typedi)
TypeDI is a [dependency injection](https://en.wikipedia.org/wiki/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:
```bash
npm install typedi reflect-metadata
```
Import the `reflect-metadata` package at the **first line** of your application:
```ts
import 'reflect-metadata';
// Your other imports and initialization code
// comes here after you imported the reflect-metadata package!
```
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:
```json
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
```
Now you are ready to use TypeDI with Typescript!
## Basic Usage
```ts
import { Container, Service } from 'typedi';
@Service()
class ExampleInjectedService {
printMessage() {
console.log('I am alive!');
}
}
@Service()
class ExampleService {
constructor(
// 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
serviceInstance.injectedService.printMessage();
// logs "I am alive!" to the console
```
## 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](./CONTRIBUTING.md) to get started.