How mganchas/ts-inject works
Project Type and Purpose
• Type: A lightweight, type-safe Dependency Injection (DI) library for TypeScript.
• Purpose: Provide a container, registration API, and injection mechanisms (class-based and function-based) to manage dependencies in TS apps.
File Structure
Top-level:
• src/
– container.ts: Core DI container (register, resolve)
– autowire.ts: Class-based injection helpers
– autowireFn.ts: Function-based injection helpers
– index.ts: Public exports
– types.ts: Core interfaces/types
• __tests__/…: Unit tests for container behavior
• examples/…: Sample consumer code showing how to use ts-inject with classes, functions, configs
• config files: tsconfig.json, eslint, jest.config.js, etc.
Main Components
A. Core Library
1. DI Container (container.ts)
– Responsibilities: register providers (classes/factories/values), resolve tokens, lifecycle (singleton/transient)
2. Class Injector (autowire.ts)
– Uses metadata to inject constructor parameters or properties
3. Function Injector (autowireFn.ts)
– Wraps factory functions with argument injection
4. Public API (index.ts)
– Exposes container creation, decorators/hooks
5. Type Definitions (types.ts)
– Defines interfaces: Token, Provider, Scope, etc.
B. Consumers (Examples)
– Class example: UserService → autowire decorators
– Function example: logMessage, sendEmail → autowireFn usage
– Config example: keys.ts
C. Tests
– container.test.ts ensures register/resolve works
Relationships and Data Flow
• Consumer Code → calls Container.register() (binding tokens to providers)
• Consumer Code → calls Container.resolve() or uses @Inject/@Injectable (autowire)
• DI Container → looks up Provider map → instantiates or returns existing instance
• autowire/autowireFn → act as glue between consumer classes/functions and the container
• types.ts → underpins all compile-time safety, shown as a “type system” layer
Architectural Patterns and Principles
• Inversion of Control (IoC) via a central container
• Factory pattern: providers can be class constructors or factory functions
• Decorator/metadata: class-based injection hooks into TS metadata
• Functional composition: autowireFn wraps pure functions