Register a dependency.
+The identifier of the dependency.
+The dependency to register.
+If true, the dependency is deprecated => a warning +is logged when the dependency is resolved.
+Resolve a dependency
+The identifier of the dependency
+If true, throws an error if the dependency is not found
+The resolved dependency or undefined if the dependency is not found
+StaticgetStaticregisterStaticresolveError class for dependency resolution errors in ITSinjex.
+Creates a new instance of DependencyResolutionError
+The identifier of the dependency
+General error class for ITSinjex interface.
+Creates a new instance of TSinjexError
+The error message
++ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| src | +
+
+ |
+ 85.71% | +18/21 | +81.81% | +9/11 | +100% | +6/6 | +84.21% | +16/19 | +
| src/__tests__ | +
+
+ |
+ 100% | +20/20 | +100% | +0/0 | +100% | +7/7 | +100% | +19/19 | +
| src/helper | +
+
+ |
+ 100% | +2/2 | +100% | +0/0 | +100% | +2/2 | +100% | +2/2 | +
| src/interfaces | +
+
+ |
+ 100% | +6/6 | +100% | +0/0 | +100% | +2/2 | +100% | +6/6 | +
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 | 1x +1x + + + + + + + +1x + +1x + + + + + + + + + + + + + +6x +1x + + +6x + + + + + + + + + + + +1x + + + + + + + + + + + + + +2x + + + + + + + + + + + + + + + + + +1x + + + + + + + + + +3x + +3x +1x +2x + + + +2x + + + + + + + +2x + + + + + | import { ImplementsStatic } from './helper/ImplementsStatic';
+import { DependencyResolutionError } from './interfaces/Exceptions';
+import { IDependency } from './interfaces/IDependency';
+import { ITSinjex, ITSinjex_ } from './interfaces/ITSinjex';
+
+/**
+ * **TSInjex**: Dependency Injection Container
+ */
+@ImplementsStatic<ITSinjex_>()
+export class TSinjex implements ITSinjex {
+ private static _instance: TSinjex;
+ private readonly _dependencies = new Map<string, IDependency>();
+
+ /**
+ * Private constructor to prevent direct instantiation.
+ */
+ private constructor() {}
+
+ //#region IDIContainer_
+
+ /**
+ * Retrieves the singleton instance of DependencyRegistry.
+ * @returns The singleton instance.
+ */
+ public static getInstance(): ITSinjex {
+ if (this._instance == null) {
+ this._instance = new TSinjex();
+ }
+
+ return this._instance;
+ }
+
+ /**
+ * @inheritdoc
+ * @see {@link ITSinjex.register}
+ */
+ public static register<T>(
+ identifier: string,
+ dependency: T,
+ deprecated = false,
+ ): void {
+ (TSinjex.getInstance() as TSinjex)._dependencies.set(identifier, {
+ dependency: dependency,
+ deprecated: deprecated,
+ });
+ }
+
+ /**
+ * @inheritdoc
+ * @see {@link ITSinjex.resolve}
+ */
+ public static resolve<T>(
+ identifier: string,
+ necessary = true,
+ ): T | undefined {
+ return (TSinjex.getInstance() as TSinjex).resolve<T>(
+ identifier,
+ necessary,
+ );
+ }
+
+ //#endregion
+
+ //#region IDIContainer
+
+ /**
+ * @inheritdoc
+ */
+ public register<T>(
+ identifier: string,
+ dependency: T,
+ deprecated = false,
+ ): void {
+ this._dependencies.set(identifier, {
+ dependency: dependency,
+ deprecated: deprecated,
+ });
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public resolve<T>(identifier: string, necessary = true): T | undefined {
+ const dependency = this._dependencies.get(identifier);
+
+ if (necessary && !dependency) {
+ throw new DependencyResolutionError(identifier);
+ } else Iif (!dependency) {
+ return undefined;
+ }
+
+ Iif (dependency.deprecated) {
+ // eslint-disable-next-line no-console
+ console.warn(`Dependency ${identifier} is deprecated`);
+
+ // Remove the deprecation warning; it should only be logged once.
+ dependency.deprecated = false;
+ }
+
+ return dependency.dependency as T;
+ }
+
+ //#endregion
+}
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 | + + + + + + +1x +1x + + +1x +3x + + +1x +1x +1x + +1x + + +1x +1x + + +1x +1x +1x + +1x + + +1x +1x + + +1x +1x + +1x + + + + + + | import { ITSinjex_, ITSinjex } from '../interfaces/ITSinjex';
+
+/**
+ * Test the implementation of a DIContainer
+ * @param Container The DIContainer implementation to test.
+ * Must implement {@link ITSinjex}, {@link ITSinjex_}
+ */
+export function test_IDIContainer(Container: ITSinjex_): void {
+ describe('IDIContainer Implementation Tests', () => {
+ let container: ITSinjex;
+
+ beforeEach(() => {
+ container = Container.getInstance();
+ });
+
+ it('should register and resolve a dependency', () => {
+ const identifier = 'myDependency';
+ const dependency = { value: 42 };
+
+ container.register(identifier, dependency);
+
+ const resolvedDependency =
+ container.resolve<typeof dependency>(identifier);
+ expect(resolvedDependency).toBe(dependency);
+ });
+
+ it('should register and resolve a dependency static', () => {
+ const identifier = 'myDependency';
+ const dependency = { value: 42 };
+
+ Container.register(identifier, dependency);
+
+ const resolvedDependency =
+ Container.resolve<typeof dependency>(identifier);
+ expect(resolvedDependency).toBe(dependency);
+ });
+
+ it('should throw an error when resolving a non-registered dependency static', () => {
+ const identifier = 'nonExistentDependency';
+
+ expect(() => Container.resolve<unknown>(identifier)).toThrow();
+ });
+
+ // Add more tests as necessary
+ });
+}
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| IDIContainer.spec.ts | +
+
+ |
+ 100% | +20/20 | +100% | +0/0 | +100% | +7/7 | +100% | +19/19 | +
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| 1 +2 +3 +4 +5 +6 +7 +8 +9 | + + + + +1x +1x + + | /**
+ * Decorator to enforce static implementation of an interface.
+ * Warns on compile time if the interface is not implemented.
+ * @returns A decorator function
+ */
+export function ImplementsStatic<I>() {
+ return <T extends I>(constructor: T, ...args: unknown[]) => {};
+}
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| ImplementsStatic.ts | +
+
+ |
+ 100% | +2/2 | +100% | +0/0 | +100% | +2/2 | +100% | +2/2 | +
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| TSinjex.ts | +
+
+ |
+ 85.71% | +18/21 | +81.81% | +9/11 | +100% | +6/6 | +84.21% | +16/19 | +
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 | + + + + +1x + + + + + +1x +1x + + + + + + + +1x + + + + + +1x +1x + + + | import { ITSinjex } from './ITSinjex';
+
+/**
+ * General error class for {@link ITSinjex} interface.
+ */
+export class TSinjexError extends Error {
+ /**
+ * Creates a new instance of {@link TSinjexError}
+ * @param message **The error message**
+ */
+ constructor(message: string) {
+ super(message);
+ this.name = 'TSInjex';
+ }
+}
+
+/**
+ * Error class for dependency resolution errors in {@link ITSinjex}.
+ * @see {@link ITSinjex.resolve}
+ */
+export class DependencyResolutionError extends TSinjexError {
+ /**
+ * Creates a new instance of {@link DependencyResolutionError}
+ * @param identifier **The identifier of the dependency**
+ */
+ constructor(identifier: string) {
+ super(`Dependency ${identifier} not found.`);
+ this.name = 'TSInjexResolutionError';
+ }
+}
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| Exceptions.ts | +
+
+ |
+ 100% | +6/6 | +100% | +0/0 | +100% | +2/2 | +100% | +6/6 | +
A decorator to inject a dependency from a DI (Dependency Injection) container. +The dependency is lazily evaluated when the property is accessed for the first time. +This can help avoid issues like circular dependencies and not-found dependencies.
+The identifier used to resolve the dependency from the DI container.
+Optionalinit: InitDelegate<T, U>An optional initializer function to transform the dependency before injection.
+Indicates if the dependency is necessary.
+true, an error will be thrown if the dependency cannot be resolved.false, undefined will be returned if the dependency cannot be resolved.A decorator function to be applied on the class property.
+A decorator to register a class in the DI (Dependency Injection) container.
+The type of the class to be registered.
+The identifier used to register the class in the DI container.
+Optionaldeprecated: booleanIf true, the dependency is deprecated => a warning +is logged when the dependency is resolved.
+A function that is applied as a decorator to the class.
+Rest...args: unknown[]A decorator to register an instance of a class in the DI (Dependency Injection) container. +The instance is created only when it is first needed (Lazy Initialization).
+The type of the class whose instance is to be registered.
+The identifier used to register the instance in the DI container.
+Optionalinit: InitDelegate<TargetType & (new (..._args: unknown[]) => InstanceType<TargetType>), InstanceType<TargetType>>An optional initializer function which get the constructor of the class +as input and returns an instance of the class.
+A function that is applied as a decorator to the class.
+Rest...args: unknown[]Register a dependency.
+Register a dependency.
+The identifier of the dependency.
+The dependency to register.
+Register a dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: trueA warning is logged when the dependency is resolved.
+Resolve a dependency.
+The identifier of the dependency.
+If true, throws an error if the dependency is not found.
+The resolved dependency or undefined if the dependency is not necessary +and not found, or throws an error if the dependency is necessary and not found.
+A DependencyResolutionError if the dependency is not found and necessary.
+Resolve a dependency.
+The identifier of the dependency.
+The resolved dependency.
+A DependencyResolutionError if the dependency is not found.
+Resolve a dependency
+The identifier of the dependency.
+The dependency is not necessary.
+The resolved dependency or undefined if the dependency is not found.
+module.exports = {
setupFilesAfterEnv: ['./scripts/jest.setup.js'],
preset: 'ts-jest',
testEnvironment: 'node',
testMatch: ['**/__tests__/**/*.test.ts', '**/?(*.)+(test).ts'],
moduleDirectories: ['node_modules', 'src'],
moduleNameMapper: {
'^src/(.*)$': '<rootDir>/src/$1', // Map src to the source folder
'^ts-injex$': '<rootDir>/node_modules/ts-injex/src', // Map ts-injex to the source folder
},
transformIgnorePatterns: [
'node_modules/(?!ts-injex)' // **Dont** ignore ts-injex on preset `ts-jest`
],
};
+Dependency Entry Interface
+TSInjex Interface
+Register a dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: booleanIf true, the dependency is deprecated => a warning +is logged when the dependency is resolved.
+Register a deprecated dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: trueA warning is logged when the dependency is resolved.
+Register a dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: falseNo warning is logged when the dependency is resolved.
+Resolve a dependency
+The identifier of the dependency
+Optionalnecessary: booleanIf true, throws an error if the dependency is not found
+The resolved dependency or undefined if the dependency is not found
+Resolve a necessary dependency.
+The identifier of the dependency.
+Optionalnecessary: trueIf true, throws an error if the dependency is not found.
+The resolved dependency.
+Resolve a non necessary dependency
+The identifier of the dependency
+Optionalnecessary: falseNot necessary, does not throw an error if the dependency is not found.
+The resolved dependency or undefined if the dependency is not found
+Register method for static and instance Dependency Injection Container.
+Register a dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: booleanIf true, the dependency is deprecated => a warning +is logged when the dependency is resolved.
+Register a deprecated dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: trueA warning is logged when the dependency is resolved.
+Register a dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: falseNo warning is logged when the dependency is resolved.
+Resolve method for static and instance Dependency Injection Container.
+Resolve a dependency
+The identifier of the dependency
+Optionalnecessary: booleanIf true, throws an error if the dependency is not found
+The resolved dependency or undefined if the dependency is not found
+Resolve a necessary dependency.
+The identifier of the dependency.
+Optionalnecessary: trueIf true, throws an error if the dependency is not found.
+The resolved dependency.
+Resolve a non necessary dependency
+The identifier of the dependency
+Optionalnecessary: falseNot necessary, does not throw an error if the dependency is not found.
+The resolved dependency or undefined if the dependency is not found
+Static TSInjex Interface
+Register a dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: booleanIf true, the dependency is deprecated => a warning +is logged when the dependency is resolved.
+Register a deprecated dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: trueA warning is logged when the dependency is resolved.
+Register a dependency.
+The identifier of the dependency.
+The dependency to register.
+Optionaldeprecated: falseNo warning is logged when the dependency is resolved.
+Resolve a dependency
+The identifier of the dependency
+Optionalnecessary: booleanIf true, throws an error if the dependency is not found
+The resolved dependency or undefined if the dependency is not found
+Resolve a necessary dependency.
+The identifier of the dependency.
+Optionalnecessary: trueIf true, throws an error if the dependency is not found.
+The resolved dependency.
+Resolve a non necessary dependency
+The identifier of the dependency
+Optionalnecessary: falseNot necessary, does not throw an error if the dependency is not found.
+The resolved dependency or undefined if the dependency is not found
+A function type representing an initializer that transforms an input of type T
+into an output of type U.
TSInjex: Dependency Injection Container
+