Illuma plugin for reflect-metadata based dependency injection to declare dependencies via constructor parameters and decorators.
Note
This package is in early development. Expect API changes in minor versions.
- Leverages
reflect-metadatato automatically resolve constructor dependencies by type. - Provides
@Injectdecorator for token-based injection on properties and constructor parameters. - Supports optional dependencies via
@Optionaldecorator.
Assuming you have @illuma/core installed, you can add this plugin and reflect-metadata via Yarn or NPM:
yarn add @illuma/core-reflect reflect-metadata
# or
npm install @illuma/core-reflect reflect-metadata| Package version | Illuma Version |
|---|---|
@illuma/core-reflect ^1.0.0 |
@illuma/core ^1.0.0 |
@illuma/core-reflect ^1.3.1 |
@illuma/core ^1.3.1 |
This plugin provides decorators to enable reflection-based dependency injection with @illuma/core.
import "reflect-metadata"; // Import this once at the entry point
import { NodeContainer, NodeInjectable, NodeToken, nodeInject } from "@illuma/core";
import { ReflectInjectable, Inject, Optional } from "@illuma/core-reflect";
// Define tokens
const API_KEY = new NodeToken<string>("API_KEY");
// Standard Illuma service
@NodeInjectable()
class Logger {
public log(message: string) {
console.log(message);
}
}
// Service using ReflectInjectable
@ReflectInjectable()
class UserService {
// Compatible with nodeInject property injection
private readonly config = nodeInject(CONFIG_TOKEN);
constructor(
// Automatically resolved by type
private readonly logger: Logger,
// Optional dependency
@Optional() private readonly tracer?: TracerService,
// Token injection
@Inject(API_KEY) private readonly key: string,
) {}
public greet() {
this.logger.log(`Hello! Key: ${this.apiKey}`);
}
}
// Setup container
const container = new NodeContainer();
container.provide({ provide: API_KEY, value: "secret-123" });
container.provide(Logger);
container.provide(UserService);
container.bootstrap();
// Resolve
const user = container.get(UserService);
user.greet();@illuma/core-reflect is fully compatible with standard @illuma/core decorators and injection methods. You can mix and match @NodeInjectable, nodeInject, and @ReflectInjectable, @Inject as needed.
@ReflectInjectable(): Marks a class as injectable (similarly to@NodeInjectable()) and resolves constructor dependencies automatically.@Inject(token): Property or parameter decorator for token injection, alternative tonodeInject.@Optional(): Marks a constructor dependency as optional.
MIT