Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uditalias/injex
Simple, Decorated, Pluggable dependency-injection framework for TypeScript applications
https://github.com/uditalias/injex
container dependency dependency-injection-container inject ioc
Last synced: 1 day ago
JSON representation
Simple, Decorated, Pluggable dependency-injection framework for TypeScript applications
- Host: GitHub
- URL: https://github.com/uditalias/injex
- Owner: uditalias
- License: mit
- Created: 2020-02-02T19:50:56.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-28T02:30:27.000Z (6 months ago)
- Last Synced: 2024-12-13T00:53:32.701Z (10 days ago)
- Topics: container, dependency, dependency-injection-container, inject, ioc
- Language: TypeScript
- Homepage: https://www.injex.dev
- Size: 20.5 MB
- Stars: 84
- Watchers: 5
- Forks: 3
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Injex 
Simple, Decorated, Pluggable dependency-injection framework for TypeScript applications
Injex makes software architecture more easy & fun by creating a dependency tree between your application modules with a minimal API.
[Home](https://www.injex.dev)
·
[Docs](https://www.injex.dev/docs/introduction)
·
[Runtimes](https://www.injex.dev/docs/runtimes/node)
·
[Plugins](https://www.injex.dev/docs/plugins)
·
[Examples](https://www.injex.dev/docs/examples)
## Installation
Start by installing the core package. This package includes most of the functionality you're going to use when working with the Injex framework.
```bash
npm install --save @injex/core
```
After the core is installed and based on your project, you need to install a runtime container. The runtime container enables modules definition and registration across your application.
You can currently choose between the Node, Webpack or Vite runtimes for the server or the client.
#### Node Runtime
Create a dependency-injection container inside a Node.JS application.
```bash
npm install --save @injex/node
```
#### Webpack Runtime
Create a dependency-injection container inside a Webpack client-side application.
```bash
npm install --save @injex/webpack
```
#### Vite Runtime
Create a dependency-injection container inside a Vite client-side application.
```bash
npm install --save @injex/vite
```
## Getting Started
### Basic Usage
Create an Injex Node runtime container.
```typescript
import { Injex } from "@injex/node";
Injex.create({
rootDirs: [
"./src"
]
}).bootstrap()
```
Injex will scan all the files and folders recursively and look for Injex modules.
Module definition example:
```typescript
// src/services/mailService.ts
import { define, singleton, inject } from "@injex/core";
@define()
@singleton()
export class MailService {
@inject() private mailProvider: IMailProvider;
public sendMail(mail: Mail) {
this.mailProvider.send(mail);
}
}
```
Since Injex automatically scans all the files and folders inside the `rootDirs`, this is all you need to do to create an injectable module.
[Learn more >>](https://www.injex.dev/docs/getting-started)
### Plugins
Injex is pluggable, so you can use and create your plugins to enrich your applications.
📦 **Env Plugin** - Manage environment variables across your application. [Docs →](https://www.injex.dev/docs/plugins/env)
📦 **Express Plugin** - Use Injex to power up your Express application by creating controllers, better route handlers, and middlewares. [Docs →](https://www.injex.dev/docs/plugins/express)
📦 **React Plugin** - Use React hooks to inject dependencies into components. [Docs →](https://www.injex.dev/docs/plugins/react)
[Learn more](https://www.injex.dev/docs/plugins) about Injex plugins and the plugin anatomy.
## Live Example
Checkout this live chat application built with Injex & Injex Plugins using React and Mobx
- **[https://chat.injex.dev](https://chat.injex.dev)** ([source](examples/injex-react-plugin-example/))
## Follow Us
Follow us on [Twitter](https://twitter.com/injex_framework) or join our live [Discord](https://discord.gg/JWxbhXd8aX) server for more help, ideas, and discussions.
## Author
| [](http://twitter.com/uditalias "Follow @uditalias on Twitter") |
|---|
| [Udi Talias](https://github.com/uditalias/) |
## License
This repository is available under the [MIT License](./LICENSE).
---
