Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/botflux/dependency-injection-container
A dependency injection container written in typescript
https://github.com/botflux/dependency-injection-container
decorators dependency dependency-injection dependency-injection-container services
Last synced: 23 days ago
JSON representation
A dependency injection container written in typescript
- Host: GitHub
- URL: https://github.com/botflux/dependency-injection-container
- Owner: botflux
- License: mit
- Created: 2020-01-16T09:47:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T05:14:22.000Z (about 2 years ago)
- Last Synced: 2024-10-10T22:34:40.711Z (3 months ago)
- Topics: decorators, dependency, dependency-injection, dependency-injection-container, services
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@botflx/dependency-injection-container
- Size: 1.73 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/botflux/dependency-injection-container)
[](https://npmjs.org/package/@botflx/dependency-injection-container)
[](https://coveralls.io/github/botflux/dependency-injection-container?branch=master)
[](https://bundlephobia.com/result?p=@botflx/dependency-injection-container)
[](https://GitHub.com/botflux/dependency-injection-container/issues/)
[](https://github.com/botflux/dependency-injection-container/blob/master/LICENSE)
## Installation
```shell script
npm i --save @botflx/dependency-injection-container
# or using yarn
yarn add @botflx/dependency-injection-container
```
## API
### Container creation
- `createServiceContainer(options: IServiceContainerFactoryOptions): IServiceContainer`
### Container usage
- `IServiceContainer.get(serviceName: string): TService`
- `IServiceContainer.add(serviceName: string, constructor: Function): IServiceContainer`
- `IServiceContainer.addService(serviceName: string, factory: Function): IServiceContainer`
- `IServiceContainer.resolve(constructor: Function): TService`
- `IServiceContainer.resolveFacory(factory: Function): TService`
- `IServiceContainer.delete(serviceName: string): IServiceContainer`
### Decorators
- `@Inject(string)`
- `@Service(string)`
## Usage
### Container with decorators
```typescript
import 'reflect-metadata'
import {createServiceContainer, Inject, Service, createReflectServiceLoader} from '@botflx/dependency-injection-container'
// Add metadata to this class, the service loader will
// be able to load those metadata and it will populate
// the service container.
@Service('Logger')
class Logger {}
@Service('UserDao')
class UserDao {
// You can inject services using the @Inject decorator.
constructor(@Inject('Logger') logger: Logger) {}
}
// The service loader role is to collect services that use @Service decorators
const serviceLoader = createReflectServiceLoader([Logger, UserDao], [])
const container = createServiceContainer({ useReflection: true, serviceLoader: serviceLoader })
const logger = container.get('Logger')
const userDao = container.get('UserDao')
```
## More examples
### Plain container examples
```typescript
import {createServiceContainer} from '@botflx/dependency-injection-container'
// It creates a plain container without decorators supports.
// You can plain container when you don't want to import 'npm i reflect-metadata'
const plainContainer = createServiceContainer({ useReflection: false })
import 'reflect-metadata'
// It creates a container that supports decorators.
// You must import the reflect-metadata package in order to use this container type.
const container = createServiceContainer({ useReflection: true })
// By default this factory creates plain container
const anotherPlainContainer = createServiceContainer()
```
### Plain container usage example
```typescript
import {createServiceContainer, IServiceContainer} from '@botflx/dependency-injection-container'
const plainContainer = createServiceContainer({ useReflection: false })
class Logger {}
class UserDao {
// When you use plain containers services will
// receive the container as first parameter.
constructor(container: IServiceContainer) {
container.get('Logger')
}
}
// Add services using the `IServiceContainer.add()`
plainContainer
.add('Logger', Logger)
.add('UserDao', UserDao)
// Get user dao using `IServiceContainer.get()`
const userDao = plainContainer.get('UserDao')
function createUserFactory (logger: Logger) {
return function (userName: string, password: string) { ... }
}
// Sometimes you can't use the class constructor, so you can use
// `IServiceContainer.addFactory()` as a fallback.
plainContainer
.addFactory('createUser', container => createUserFactory(container.get('Logger')))
```