maxp/TSinjex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(inject): rename necessary parameter to isNecessary for clarity

Browse Source
This commit is contained in:
0xMax42
2025-04-02 21:45:41 +02:00
committed by 20Max01
parent 2e89cdd619
commit 81fb7f0071
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/decorators/Inject.ts
View File

@@ -17,7 +17,7 @@ import { InitDelegate } from '../types/InitDelegate.js';
* @param init Optional an initializer function to transform the dependency before injection * @param init Optional an initializer function to transform the dependency before injection
* or true to instantiate the dependency if it has a constructor. * or true to instantiate the dependency if it has a constructor.
* @see {@link InitDelegate} for more information on initializer functions. * @see {@link InitDelegate} for more information on initializer functions.
* @param necessary If true, throws an error if the dependency is not found. * @param isNecessary If true, throws an error if the dependency is not found.
* @returns The resolved dependency or undefined if the dependency is not necessary * @returns 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. * and not found, or throws an error if the dependency is necessary and not found.
* @throws **Only throws errors if the dependency is necessary.** * @throws **Only throws errors if the dependency is necessary.**
@@ -43,7 +43,7 @@ import { InitDelegate } from '../types/InitDelegate.js';
export function Inject<T, U>( export function Inject<T, U>(
identifier: Identifier, identifier: Identifier,
init?: InitDelegate<T, U> | true, init?: InitDelegate<T, U> | true,
necessary = true, isNecessary = true,
) { ) {
return function (target: unknown, propertyKey: string | symbol): void { return function (target: unknown, propertyKey: string | symbol): void {
/** /**
@@ -52,7 +52,7 @@ export function Inject<T, U>(
* @returns The resolved dependency or undefined if the dependency is not found. * @returns The resolved dependency or undefined if the dependency is not found.
*/ */
const resolve = (): T | undefined => { const resolve = (): T | undefined => {
return TSinjex.getInstance().resolve<T>(identifier, necessary); return TSinjex.getInstance().resolve<T>(identifier, isNecessary);
}; };
Object.defineProperty(target, propertyKey, { Object.defineProperty(target, propertyKey, {
@@ -61,7 +61,7 @@ export function Inject<T, U>(
const dependency: T | undefined = tryAndCatch( const dependency: T | undefined = tryAndCatch(
() => resolve(), () => resolve(),
necessary, isNecessary,
identifier, identifier,
DependencyResolutionError, DependencyResolutionError,
); );
@@ -78,13 +78,13 @@ export function Inject<T, U>(
else if (initFunction != null) else if (initFunction != null)
instance = tryAndCatch( instance = tryAndCatch(
initFunction, initFunction,
necessary, isNecessary,
identifier, identifier,
InitializationError, InitializationError,
); );
else if (necessary) else if (isNecessary)
throw new NoInstantiationMethodError(identifier); throw new NoInstantiationMethodError(identifier);
} else if (necessary) } else if (isNecessary)
throw new DependencyResolutionError(identifier); throw new DependencyResolutionError(identifier);
/** /**