diff --git a/classes/classes_TSinjex.TSinjex.html b/classes/classes_TSinjex.TSinjex.html index bb8884f..9a2aed5 100644 --- a/classes/classes_TSinjex.TSinjex.html +++ b/classes/classes_TSinjex.TSinjex.html @@ -1,4 +1,4 @@ -TSinjex | ts-injex - v0.0.11

Class TSinjex

TSinjex

The main class for the Dependency Injection Container TSinjex.

+TSinjex | ts-injex - v0.0.12

Class TSinjex

TSinjex

The main class for the Dependency Injection Container TSinjex.

Decorators

See

  • Register for registering a class in the DI container.
  • RegisterInstance for registering an instance in the DI container.
    • @@ -9,7 +9,7 @@
  • register for registering a dependency (class or instance) as a function.
  • resolve for resolving a dependency as a function.
-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_dependencies _instance

Methods

register @@ -18,22 +18,22 @@ register resolve

Constructors

Privateconstructor

Properties

Private Readonly_dependencies

_dependencies: Map<string, IDependency> = ...

The dependencies map.

-

Private Static_instance

_instance: TSinjex

The singleton instance of the TSinjex class.

-

Methods

register

Properties

Private Readonly_dependencies

_dependencies: Map<string, IDependency> = ...

The dependencies map.

+

Private Static_instance

_instance: TSinjex

The singleton instance of the TSinjex class.

+

Methods

register

  • register<T>(identifier, dependency, deprecated?): void

  • Register a dependency.

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier of the dependency.

    • dependency: T

      The dependency to register.

    • deprecated: boolean = false

      If true, the dependency is deprecated => a warning is logged when the dependency is resolved.

      -

    Returns void

resolve

  • resolve<T>(identifier, necessary?): undefined | T

  • Resolve a dependency

    +

Returns void

resolve

  • resolve<T>(identifier, necessary?): undefined | T

  • Resolve a dependency

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier of the dependency

    • necessary: boolean = true

      If true, throws an error if the dependency is not found

    Returns undefined | T

    The resolved dependency or undefined if the dependency is not found

    Throws

    A DependencyResolutionError if the dependency is not found and necessary.

    -

StaticgetInstance

StaticgetInstance

Staticregister

Staticregister

Staticresolve

Staticresolve

Settings

Member Visibility

On This Page

TSinjex
Constructors
Properties
Methods
+

Inherit Doc

Settings

Member Visibility

On This Page

TSinjex
Constructors
Properties
Methods
diff --git a/classes/interfaces_Exceptions.DependencyResolutionError.html b/classes/interfaces_Exceptions.DependencyResolutionError.html index 5c9edc0..7d9e1de 100644 --- a/classes/interfaces_Exceptions.DependencyResolutionError.html +++ b/classes/interfaces_Exceptions.DependencyResolutionError.html @@ -1,6 +1,6 @@ -DependencyResolutionError | ts-injex - v0.0.11

Class DependencyResolutionError

Error class for dependency resolution errors in ITSinjex.

+DependencyResolutionError | ts-injex - v0.0.12

Class DependencyResolutionError

Error class for dependency resolution errors in ITSinjex.

See

ITSinjex.resolve

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

message name stack? @@ -9,7 +9,7 @@

Methods

captureStackTrace

Constructors

constructor

Properties

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Returns DependencyResolutionError

Properties

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Parameters

  • targetObject: object
  • OptionalconstructorOpt: Function

Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/interfaces_Exceptions.TSinjexError.html b/classes/interfaces_Exceptions.TSinjexError.html index 846e20d..ad51b98 100644 --- a/classes/interfaces_Exceptions.TSinjexError.html +++ b/classes/interfaces_Exceptions.TSinjexError.html @@ -1,5 +1,5 @@ -TSinjexError | ts-injex - v0.0.11

Class TSinjexError

General error class for ITSinjex interface.

-

Hierarchy (view full)

Constructors

constructor +TSinjexError | ts-injex - v0.0.12

Class TSinjexError

General error class for ITSinjex interface.

+

Hierarchy (view full)

Constructors

constructor

Properties

message name stack? @@ -8,7 +8,7 @@

Methods

captureStackTrace

Constructors

constructor

Properties

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Returns TSinjexError

Properties

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Parameters

Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/coverage/lcov-report/classes/TSinjex.ts.html b/coverage/lcov-report/classes/TSinjex.ts.html index b914f57..fa799a4 100644 --- a/coverage/lcov-report/classes/TSinjex.ts.html +++ b/coverage/lcov-report/classes/TSinjex.ts.html @@ -451,7 +451,7 @@ export class TSinjex implements ITSinjex {
Code coverage generated by istanbul - at 2024-08-16T16:38:59.040Z + at 2024-08-16T16:43:37.602Z

Function Inject

  • Inject<T, U>(identifier, init?, necessary?): ((target: unknown, propertyKey: string | symbol) => void)

  • A decorator to inject a dependency from a DI (Dependency Injection) container into a class property.

    +Inject | ts-injex - v0.0.12

    Function Inject

    • Inject<T, U>(identifier, init?, necessary?): ((target: unknown, propertyKey: string | symbol) => void)

    • A decorator to inject a dependency from a DI (Dependency Injection) container into a class property.

      Type Parameters

      • T

        The type of the dependency to be injected.

      • U

        The type of the property to be injected.

      Parameters

      • identifier: string

        The identifier used to resolve the class in the DI container.

        @@ -17,4 +17,4 @@ and not found, or throws an error if the dependency is necessary and not found.<

        Example

        class MyClass {
          @Inject('ILogger_', (x: ILogger_) => x.getLogger('Tags'), false)
          private _logger?: ILogger;
        }
        -

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/functions/decorators_Register.Register.html b/functions/decorators_Register.Register.html index c6947f2..6f1fef2 100644 --- a/functions/decorators_Register.Register.html +++ b/functions/decorators_Register.Register.html @@ -1,4 +1,4 @@ -Register | ts-injex - v0.0.11

Function Register

  • Register<TargetType>(identifier, deprecated?): ((constructor: TargetType, ...args: unknown[]) => void)

  • A decorator to register a class in the TSinjex DI (Dependency Injection) container.

    +Register | ts-injex - v0.0.12

    Function Register

    • Register<TargetType>(identifier, deprecated?): ((constructor: TargetType, ...args: unknown[]) => void)

    • A decorator to register a class in the TSinjex DI (Dependency Injection) container.

      Type Parameters

      • TargetType extends (new (...args: unknown[]) => InstanceType<TargetType>)

        The type of the class to be registered.

      Parameters

      • identifier: string

        The identifier used to register the class in the DI container.

      • Optionaldeprecated: boolean

        If true, the dependency is deprecated and a warning @@ -8,4 +8,4 @@ is logged only once upon the first resolution of the dependency.

        Example

        @Register('MyClassIdentifier')
        class MyClass {
          // ...
        }
        -

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/functions/decorators_RegisterInstance.RegisterInstance.html b/functions/decorators_RegisterInstance.RegisterInstance.html index d3b5786..8c0bd92 100644 --- a/functions/decorators_RegisterInstance.RegisterInstance.html +++ b/functions/decorators_RegisterInstance.RegisterInstance.html @@ -1,4 +1,4 @@ -RegisterInstance | ts-injex - v0.0.11

Function RegisterInstance

  • RegisterInstance<TargetType>(identifier, init?): ((constructor: TargetType, ...args: unknown[]) => void)

  • A decorator to register an instance of a class in the DI (Dependency Injection) container.

    +RegisterInstance | ts-injex - v0.0.12

    Function RegisterInstance

    • RegisterInstance<TargetType>(identifier, init?): ((constructor: TargetType, ...args: unknown[]) => void)

    • A decorator to register an instance of a class in the DI (Dependency Injection) container.

      Type Parameters

      • TargetType extends (new (..._args: unknown[]) => InstanceType<TargetType>)

        The type of the class whose instance is to be registered.

      Parameters

      • identifier: string

        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 @@ -11,4 +11,4 @@ as input and returns an instance of the class.

        Example

        @RegisterInstance('MyClassInstanceIdentifier', (constructor) => new constructor())
        class MyClass {
          // ...
        }
        -

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/functions/functions_register.register.html b/functions/functions_register.register.html index 5b67030..e685f2d 100644 --- a/functions/functions_register.register.html +++ b/functions/functions_register.register.html @@ -1,4 +1,4 @@ -register | ts-injex - v0.0.11

Function register

Register a dependency.

+register | ts-injex - v0.0.12

Function register

Register a dependency.

Param: identifier

The identifier used to register the class in the DI container.

See

Identifier for more information on identifiers.

Param: dependency

The dependency to register.

@@ -8,9 +8,9 @@ is logged when the dependency is resolved.

Type Parameters

  • T

Parameters

  • identifier: string

    The identifier used to register the class in the DI container.

  • dependency: T

    The dependency to register.

Returns void

See

Identifier for more information on identifiers..

-
  • register<T>(identifier, dependency, deprecated?): void

  • Register a dependency.

    +
  • register<T>(identifier, dependency, deprecated?): void

  • Register a dependency.

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier used to register the class in the DI container.

    • dependency: T

      The dependency to register.

    • Optionaldeprecated: true

      A warning is logged when the dependency is resolved.

    Returns void

    See

    Identifier for more information on identifiers.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/functions_resolve.resolve.html b/functions/functions_resolve.resolve.html index c9e7667..ea02b99 100644 --- a/functions/functions_resolve.resolve.html +++ b/functions/functions_resolve.resolve.html @@ -1,4 +1,4 @@ -resolve | ts-injex - v0.0.11

    Function resolve

    Resolve a dependency.

    +resolve | ts-injex - v0.0.12

    Function resolve

    Resolve a dependency.

    Param: identifier

    The identifier used to register the class in the DI container.

    See

    Identifier for more information on identifiers.

    Param: necessary

    If true, throws an error if the dependency is not found.

    @@ -10,9 +10,9 @@ and not found, or throws an error if the dependency is necessary and not found.<

    Returns T

    The resolved dependency.

    See

    Identifier for more information on identifiers.

    Throws

    A DependencyResolutionError if the dependency is not found.

    -
  • resolve<T>(identifier, necessary): T | undefined

  • Resolve a dependency

    +
  • resolve<T>(identifier, necessary): T | undefined

  • Resolve a dependency

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier used to register the class in the DI container.

    • necessary: false

      The dependency is not necessary.

    Returns T | undefined

    The resolved dependency or undefined if the dependency is not found.

    See

    Identifier for more information on identifiers.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/helper_ImplementsStatic.ImplementsStatic.html b/functions/helper_ImplementsStatic.ImplementsStatic.html index 49eafca..9e2e3f7 100644 --- a/functions/helper_ImplementsStatic.ImplementsStatic.html +++ b/functions/helper_ImplementsStatic.ImplementsStatic.html @@ -1,4 +1,4 @@ -ImplementsStatic | ts-injex - v0.0.11

    Function ImplementsStatic

    • ImplementsStatic<I>(): (<T>(constructor: T, ...args: unknown[]) => void)

    • Decorator to enforce static implementation of an interface. +ImplementsStatic | ts-injex - v0.0.12

      Function ImplementsStatic

      • ImplementsStatic<I>(): (<T>(constructor: T, ...args: unknown[]) => void)

      • Decorator to enforce static implementation of an interface. Warns on compile time if the interface is not implemented.

        Type Parameters

        • I

        Returns (<T>(constructor: T, ...args: unknown[]) => void)

        A decorator function

        -
          • <T>(constructor, ...args): void

          • Type Parameters

            • T

            Parameters

            • constructor: T
            • Rest...args: unknown[]

            Returns void

      Settings

      Member Visibility
      +
        • <T>(constructor, ...args): void

        • Type Parameters

          • T

          Parameters

          • constructor: T
          • Rest...args: unknown[]

          Returns void

    Settings

    Member Visibility
    diff --git a/hierarchy.html b/hierarchy.html index 23aceae..f918a7b 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -ts-injex - v0.0.11

    ts-injex - v0.0.11

    Class Hierarchy

    Settings

    Member Visibility
    +ts-injex - v0.0.12

    ts-injex - v0.0.12

    Class Hierarchy

    Settings

    Member Visibility
    diff --git a/index.html b/index.html index a7e5437..86351ce 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -ts-injex - v0.0.11

    ts-injex - v0.0.11

    Time

    +ts-injex - v0.0.12

    ts-injex - v0.0.12

    Time

    Statements Branches Functions Lines

    TSinjex

    Configuration

    Jest

    Example jest setup

    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`
        ],
    };
    -

    Settings

    Member Visibility

    On This Page

    TSinjex
    +

    Settings

    Member Visibility

    On This Page

    TSinjex
    diff --git a/interfaces/interfaces_IDependency.IDependency.html b/interfaces/interfaces_IDependency.IDependency.html index 1e2c4df..0bda7f7 100644 --- a/interfaces/interfaces_IDependency.IDependency.html +++ b/interfaces/interfaces_IDependency.IDependency.html @@ -1,7 +1,7 @@ -IDependency | ts-injex - v0.0.11

    Interface IDependency

    Dependency Entry Interface

    -
    interface IDependency {
        dependency: unknown;
        deprecated?: boolean;
    }

    Properties

    dependency +IDependency | ts-injex - v0.0.12

    Interface IDependency

    Dependency Entry Interface

    +
    interface IDependency {
        dependency: unknown;
        deprecated?: boolean;
    }

    Properties

    dependency deprecated?

    Properties

    dependency

    dependency: unknown

    The dependency itself

    -

    Optionaldeprecated

    deprecated?: boolean

    If true, the dependency is deprecated => a warning +

    Optionaldeprecated

    deprecated?: boolean

    If true, the dependency is deprecated => a warning is logged when the dependency is resolved

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/interfaces_ITSinjex.ITSinjex.html b/interfaces/interfaces_ITSinjex.ITSinjex.html index 5a6af14..a77acac 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjex.html +++ b/interfaces/interfaces_ITSinjex.ITSinjex.html @@ -1,31 +1,31 @@ -ITSinjex | ts-injex - v0.0.11

    Interface ITSinjex

    Instance TSinjex Interface

    -
    interface ITSinjex {
        register<T>(identifier: string, dependency: T, deprecated?: boolean): void;
        register<T>(identifier: string, dependency: T, deprecated?: true): void;
        register<T>(identifier: string, dependency: T, deprecated?: false): void;
        resolve<T>(identifier: string, necessary?: boolean): undefined | T;
        resolve<T>(identifier: string, necessary?: true): T;
        resolve<T>(identifier: string, necessary?: false): undefined | T;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    register +ITSinjex | ts-injex - v0.0.12

    Interface ITSinjex

    Instance TSinjex Interface

    +
    interface ITSinjex {
        register<T>(identifier: string, dependency: T, deprecated?: boolean): void;
        register<T>(identifier: string, dependency: T, deprecated?: true): void;
        register<T>(identifier: string, dependency: T, deprecated?: false): void;
        resolve<T>(identifier: string, necessary?: boolean): undefined | T;
        resolve<T>(identifier: string, necessary?: true): T;
        resolve<T>(identifier: string, necessary?: false): undefined | T;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    register resolve

    Methods

    register

    • register<T>(identifier, dependency, deprecated?): void

    • Register a dependency.

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency.

      • dependency: T

        The dependency to register.

      • Optionaldeprecated: boolean

        If true, the dependency is deprecated => a warning is logged when the dependency is resolved.

        -

      Returns void

    • register<T>(identifier, dependency, deprecated?): void

    • Register a deprecated dependency.

      +

    Returns void

  • register<T>(identifier, dependency, deprecated?): void

  • Register a deprecated dependency.

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier of the dependency.

    • dependency: T

      The dependency to register.

    • Optionaldeprecated: true

      A warning is logged when the dependency is resolved.

      -

    Returns void

  • register<T>(identifier, dependency, deprecated?): void

  • Register a dependency.

    +

    • Returns void

  • register<T>(identifier, dependency, deprecated?): void

  • Register a dependency.

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier of the dependency.

    • dependency: T

      The dependency to register.

    • Optionaldeprecated: false

      No warning is logged when the dependency is resolved.

      -

    Returns void

    • resolve

    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a dependency

      +

    Returns void

    resolve

    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a dependency

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency

      • Optionalnecessary: boolean

        If true, throws an error if the dependency is not found

      Returns undefined | T

      The resolved dependency or undefined if the dependency is not found

      Throws

      A DependencyResolutionError if the dependency is not found and necessary.

      -
    • resolve<T>(identifier, necessary?): T

    • Resolve a necessary dependency.

      +
    • resolve<T>(identifier, necessary?): T

    • Resolve a necessary dependency.

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency.

      • Optionalnecessary: true

        If true, throws an error if the dependency is not found.

      Returns T

      The resolved dependency.

      Throws

      A DependencyResolutionError if the dependency is not found.

      -
    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a non necessary dependency

      +
    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a non necessary dependency

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency

      • Optionalnecessary: false

        Not necessary, does not throw an error if the dependency is not found.

      Returns undefined | T

      The resolved dependency or undefined if the dependency is not found

      -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/interfaces/interfaces_ITSinjex.ITSinjexRegister.html b/interfaces/interfaces_ITSinjex.ITSinjexRegister.html index d3391cb..346f8a6 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjexRegister.html +++ b/interfaces/interfaces_ITSinjex.ITSinjexRegister.html @@ -1,16 +1,16 @@ -ITSinjexRegister | ts-injex - v0.0.11

    Interface ITSinjexRegister

    Register method for static and instance Dependency Injection Container.

    -
    interface ITSinjexRegister {
        register<T>(identifier: string, dependency: T, deprecated?: boolean): void;
        register<T>(identifier: string, dependency: T, deprecated?: true): void;
        register<T>(identifier: string, dependency: T, deprecated?: false): void;
    }

    Hierarchy (view full)

    Methods

    register +ITSinjexRegister | ts-injex - v0.0.12

    Interface ITSinjexRegister

    Register method for static and instance Dependency Injection Container.

    +
    interface ITSinjexRegister {
        register<T>(identifier: string, dependency: T, deprecated?: boolean): void;
        register<T>(identifier: string, dependency: T, deprecated?: true): void;
        register<T>(identifier: string, dependency: T, deprecated?: false): void;
    }

    Hierarchy (view full)

    Methods

    register

    Methods

    register

    • register<T>(identifier, dependency, deprecated?): void

    • Register a dependency.

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency.

      • dependency: T

        The dependency to register.

      • Optionaldeprecated: boolean

        If true, the dependency is deprecated => a warning is logged when the dependency is resolved.

        -

      Returns void

    • register<T>(identifier, dependency, deprecated?): void

    • Register a deprecated dependency.

      +

    Returns void

  • register<T>(identifier, dependency, deprecated?): void

  • Register a deprecated dependency.

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier of the dependency.

    • dependency: T

      The dependency to register.

    • Optionaldeprecated: true

      A warning is logged when the dependency is resolved.

      -

    Returns void

  • register<T>(identifier, dependency, deprecated?): void

  • Register a dependency.

    +

    • Returns void

  • register<T>(identifier, dependency, deprecated?): void

  • Register a dependency.

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier of the dependency.

    • dependency: T

      The dependency to register.

    • Optionaldeprecated: false

      No warning is logged when the dependency is resolved.

      -

    Returns void

    • Settings

    Member Visibility

    On This Page

    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/interfaces/interfaces_ITSinjex.ITSinjexResolve.html b/interfaces/interfaces_ITSinjex.ITSinjexResolve.html index 6b06406..7b606cd 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjexResolve.html +++ b/interfaces/interfaces_ITSinjex.ITSinjexResolve.html @@ -1,17 +1,17 @@ -ITSinjexResolve | ts-injex - v0.0.11

    Interface ITSinjexResolve

    Resolve method for static and instance Dependency Injection Container.

    -
    interface ITSinjexResolve {
        resolve<T>(identifier: string, necessary?: boolean): undefined | T;
        resolve<T>(identifier: string, necessary?: true): T;
        resolve<T>(identifier: string, necessary?: false): undefined | T;
    }

    Hierarchy (view full)

    Methods

    resolve +ITSinjexResolve | ts-injex - v0.0.12

    Interface ITSinjexResolve

    Resolve method for static and instance Dependency Injection Container.

    +
    interface ITSinjexResolve {
        resolve<T>(identifier: string, necessary?: boolean): undefined | T;
        resolve<T>(identifier: string, necessary?: true): T;
        resolve<T>(identifier: string, necessary?: false): undefined | T;
    }

    Hierarchy (view full)

    Methods

    resolve

    Methods

    resolve

    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a dependency

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency

      • Optionalnecessary: boolean

        If true, throws an error if the dependency is not found

      Returns undefined | T

      The resolved dependency or undefined if the dependency is not found

      Throws

      A DependencyResolutionError if the dependency is not found and necessary.

      -
    • resolve<T>(identifier, necessary?): T

    • Resolve a necessary dependency.

      +
    • resolve<T>(identifier, necessary?): T

    • Resolve a necessary dependency.

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency.

      • Optionalnecessary: true

        If true, throws an error if the dependency is not found.

      Returns T

      The resolved dependency.

      Throws

      A DependencyResolutionError if the dependency is not found.

      -
    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a non necessary dependency

      +
    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a non necessary dependency

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency

      • Optionalnecessary: false

        Not necessary, does not throw an error if the dependency is not found.

      Returns undefined | T

      The resolved dependency or undefined if the dependency is not found

      -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/interfaces/interfaces_ITSinjex.ITSinjex_.html b/interfaces/interfaces_ITSinjex.ITSinjex_.html index f7026de..64e9336 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjex_.html +++ b/interfaces/interfaces_ITSinjex.ITSinjex_.html @@ -1,34 +1,34 @@ -ITSinjex_ | ts-injex - v0.0.11

    Interface ITSinjex_

    Static TSInjex Interface

    -
    interface ITSinjex_ {
        getInstance(): ITSinjex;
        register<T>(identifier: string, dependency: T, deprecated?: boolean): void;
        register<T>(identifier: string, dependency: T, deprecated?: true): void;
        register<T>(identifier: string, dependency: T, deprecated?: false): void;
        resolve<T>(identifier: string, necessary?: boolean): undefined | T;
        resolve<T>(identifier: string, necessary?: true): T;
        resolve<T>(identifier: string, necessary?: false): undefined | T;
    }

    Hierarchy (view full)

    Methods

    getInstance +ITSinjex_ | ts-injex - v0.0.12

    Interface ITSinjex_

    Static TSInjex Interface

    +
    interface ITSinjex_ {
        getInstance(): ITSinjex;
        register<T>(identifier: string, dependency: T, deprecated?: boolean): void;
        register<T>(identifier: string, dependency: T, deprecated?: true): void;
        register<T>(identifier: string, dependency: T, deprecated?: false): void;
        resolve<T>(identifier: string, necessary?: boolean): undefined | T;
        resolve<T>(identifier: string, necessary?: true): T;
        resolve<T>(identifier: string, necessary?: false): undefined | T;
    }

    Hierarchy (view full)

    Methods

    getInstance register resolve

    Methods

    getInstance

    register

    register

    • register<T>(identifier, dependency, deprecated?): void

    • Register a dependency.

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency.

      • dependency: T

        The dependency to register.

      • Optionaldeprecated: boolean

        If true, the dependency is deprecated => a warning is logged when the dependency is resolved.

        -

      Returns void

    • register<T>(identifier, dependency, deprecated?): void

    • Register a deprecated dependency.

      +

    Returns void

  • register<T>(identifier, dependency, deprecated?): void

  • Register a deprecated dependency.

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier of the dependency.

    • dependency: T

      The dependency to register.

    • Optionaldeprecated: true

      A warning is logged when the dependency is resolved.

      -

    Returns void

  • register<T>(identifier, dependency, deprecated?): void

  • Register a dependency.

    +

    • Returns void

  • register<T>(identifier, dependency, deprecated?): void

  • Register a dependency.

    Type Parameters

    • T

    Parameters

    • identifier: string

      The identifier of the dependency.

    • dependency: T

      The dependency to register.

    • Optionaldeprecated: false

      No warning is logged when the dependency is resolved.

      -

    Returns void

    • resolve

    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a dependency

      +

    Returns void

    resolve

    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a dependency

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency

      • Optionalnecessary: boolean

        If true, throws an error if the dependency is not found

      Returns undefined | T

      The resolved dependency or undefined if the dependency is not found

      Throws

      A DependencyResolutionError if the dependency is not found and necessary.

      -
    • resolve<T>(identifier, necessary?): T

    • Resolve a necessary dependency.

      +
    • resolve<T>(identifier, necessary?): T

    • Resolve a necessary dependency.

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency.

      • Optionalnecessary: true

        If true, throws an error if the dependency is not found.

      Returns T

      The resolved dependency.

      Throws

      A DependencyResolutionError if the dependency is not found.

      -
    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a non necessary dependency

      +
    • resolve<T>(identifier, necessary?): undefined | T

    • Resolve a non necessary dependency

      Type Parameters

      • T

      Parameters

      • identifier: string

        The identifier of the dependency

      • Optionalnecessary: false

        Not necessary, does not throw an error if the dependency is not found.

      Returns undefined | T

      The resolved dependency or undefined if the dependency is not found

      -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/modules/classes_TSinjex.html b/modules/classes_TSinjex.html index 1f1f20c..a04525a 100644 --- a/modules/classes_TSinjex.html +++ b/modules/classes_TSinjex.html @@ -1,2 +1,2 @@ -classes/TSinjex | ts-injex - v0.0.11

    Module classes/TSinjex

    Index

    Classes

    TSinjex -

    Settings

    Member Visibility
    +classes/TSinjex | ts-injex - v0.0.12

    Module classes/TSinjex

    Index

    Classes

    TSinjex +

    Settings

    Member Visibility
    diff --git a/modules/decorators_Inject.html b/modules/decorators_Inject.html index 7d94fbb..96c6b54 100644 --- a/modules/decorators_Inject.html +++ b/modules/decorators_Inject.html @@ -1,2 +1,2 @@ -decorators/Inject | ts-injex - v0.0.11

    Module decorators/Inject

    Index

    Functions

    Inject -

    Settings

    Member Visibility
    +decorators/Inject | ts-injex - v0.0.12

    Module decorators/Inject

    Index

    Functions

    Inject +

    Settings

    Member Visibility
    diff --git a/modules/decorators_Register.html b/modules/decorators_Register.html index f76087e..46b939b 100644 --- a/modules/decorators_Register.html +++ b/modules/decorators_Register.html @@ -1,2 +1,2 @@ -decorators/Register | ts-injex - v0.0.11

    Module decorators/Register

    Index

    Functions

    Register -

    Settings

    Member Visibility
    +decorators/Register | ts-injex - v0.0.12

    Module decorators/Register

    Index

    Functions

    Register +

    Settings

    Member Visibility
    diff --git a/modules/decorators_RegisterInstance.html b/modules/decorators_RegisterInstance.html index 558f11f..d45355f 100644 --- a/modules/decorators_RegisterInstance.html +++ b/modules/decorators_RegisterInstance.html @@ -1,2 +1,2 @@ -decorators/RegisterInstance | ts-injex - v0.0.11

    Module decorators/RegisterInstance

    Index

    Functions

    RegisterInstance -

    Settings

    Member Visibility
    +decorators/RegisterInstance | ts-injex - v0.0.12

    Module decorators/RegisterInstance

    Index

    Functions

    RegisterInstance +

    Settings

    Member Visibility
    diff --git a/modules/functions_register.html b/modules/functions_register.html index 7e5c612..a2007ac 100644 --- a/modules/functions_register.html +++ b/modules/functions_register.html @@ -1,2 +1,2 @@ -functions/register | ts-injex - v0.0.11

    Module functions/register

    Index

    Functions

    register -

    Settings

    Member Visibility
    +functions/register | ts-injex - v0.0.12

    Module functions/register

    Index

    Functions

    register +

    Settings

    Member Visibility
    diff --git a/modules/functions_resolve.html b/modules/functions_resolve.html index 635a451..d442589 100644 --- a/modules/functions_resolve.html +++ b/modules/functions_resolve.html @@ -1,2 +1,2 @@ -functions/resolve | ts-injex - v0.0.11

    Module functions/resolve

    Index

    Functions

    resolve -

    Settings

    Member Visibility
    +functions/resolve | ts-injex - v0.0.12

    Module functions/resolve

    Index

    Functions

    resolve +

    Settings

    Member Visibility
    diff --git a/modules/helper_ImplementsStatic.html b/modules/helper_ImplementsStatic.html index fc79988..356c4d2 100644 --- a/modules/helper_ImplementsStatic.html +++ b/modules/helper_ImplementsStatic.html @@ -1,2 +1,2 @@ -helper/ImplementsStatic | ts-injex - v0.0.11

    Module helper/ImplementsStatic

    Index

    Functions

    ImplementsStatic -

    Settings

    Member Visibility
    +helper/ImplementsStatic | ts-injex - v0.0.12

    Module helper/ImplementsStatic

    Index

    Functions

    ImplementsStatic +

    Settings

    Member Visibility
    diff --git a/modules/index.html b/modules/index.html index 0488b63..863b3bb 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | ts-injex - v0.0.11

    Module index

    References

    ForceConstructor +index | ts-injex - v0.0.12

    Module index

    References

    ForceConstructor GenericConstructor ITSinjex ITSinjexRegister @@ -11,4 +11,4 @@ TSinjex register resolve -

    References

    ForceConstructor

    Re-exports ForceConstructor

    GenericConstructor

    Re-exports GenericConstructor

    ITSinjex

    Re-exports ITSinjex

    ITSinjexRegister

    Re-exports ITSinjexRegister

    ITSinjexResolve

    Re-exports ITSinjexResolve

    ITSinjex_

    Re-exports ITSinjex_

    InitDelegate

    Re-exports InitDelegate

    Inject

    Re-exports Inject

    Register

    Re-exports Register

    RegisterInstance

    Re-exports RegisterInstance

    TSinjex

    Re-exports TSinjex

    register

    Re-exports register

    resolve

    Re-exports resolve

    Settings

    Member Visibility

    On This Page

    References
    +

    References

    ForceConstructor

    Re-exports ForceConstructor

    GenericConstructor

    Re-exports GenericConstructor

    ITSinjex

    Re-exports ITSinjex

    ITSinjexRegister

    Re-exports ITSinjexRegister

    ITSinjexResolve

    Re-exports ITSinjexResolve

    ITSinjex_

    Re-exports ITSinjex_

    InitDelegate

    Re-exports InitDelegate

    Inject

    Re-exports Inject

    Register

    Re-exports Register

    RegisterInstance

    Re-exports RegisterInstance

    TSinjex

    Re-exports TSinjex

    register

    Re-exports register

    resolve

    Re-exports resolve

    Settings

    Member Visibility

    On This Page

    References
    diff --git a/modules/interfaces_Exceptions.html b/modules/interfaces_Exceptions.html index fca82b9..740099a 100644 --- a/modules/interfaces_Exceptions.html +++ b/modules/interfaces_Exceptions.html @@ -1,3 +1,3 @@ -interfaces/Exceptions | ts-injex - v0.0.11

    Module interfaces/Exceptions

    Index

    Classes

    DependencyResolutionError +interfaces/Exceptions | ts-injex - v0.0.12

    Module interfaces/Exceptions

    Index

    Classes

    DependencyResolutionError TSinjexError -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/modules/interfaces_IDependency.html b/modules/interfaces_IDependency.html index 8a0a007..a25ca63 100644 --- a/modules/interfaces_IDependency.html +++ b/modules/interfaces_IDependency.html @@ -1,2 +1,2 @@ -interfaces/IDependency | ts-injex - v0.0.11

    Module interfaces/IDependency

    Index

    Interfaces

    IDependency -

    Settings

    Member Visibility
    +interfaces/IDependency | ts-injex - v0.0.12

    Module interfaces/IDependency

    Index

    Interfaces

    IDependency +

    Settings

    Member Visibility
    diff --git a/modules/interfaces_ITSinjex.html b/modules/interfaces_ITSinjex.html index 7b20a4a..946b8fc 100644 --- a/modules/interfaces_ITSinjex.html +++ b/modules/interfaces_ITSinjex.html @@ -1,5 +1,5 @@ -interfaces/ITSinjex | ts-injex - v0.0.11

    Module interfaces/ITSinjex

    Index

    Interfaces

    ITSinjex +interfaces/ITSinjex | ts-injex - v0.0.12

    Module interfaces/ITSinjex

    Index

    Interfaces

    ITSinjex ITSinjexRegister ITSinjexResolve ITSinjex_ -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/modules/types_GenericContructor.html b/modules/types_GenericContructor.html index 7277b17..d84b3a5 100644 --- a/modules/types_GenericContructor.html +++ b/modules/types_GenericContructor.html @@ -1,3 +1,3 @@ -types/GenericContructor | ts-injex - v0.0.11

    Module types/GenericContructor

    Index

    Type Aliases

    ForceConstructor +types/GenericContructor | ts-injex - v0.0.12

    Module types/GenericContructor

    Index

    Type Aliases

    ForceConstructor GenericConstructor -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/modules/types_Identifier.html b/modules/types_Identifier.html index 963a25c..c13aab3 100644 --- a/modules/types_Identifier.html +++ b/modules/types_Identifier.html @@ -1,2 +1,2 @@ -types/Identifier | ts-injex - v0.0.11

    Module types/Identifier

    Index

    Type Aliases

    Identifier -

    Settings

    Member Visibility
    +types/Identifier | ts-injex - v0.0.12

    Module types/Identifier

    Index

    Type Aliases

    Identifier +

    Settings

    Member Visibility
    diff --git a/modules/types_InitDelegate.html b/modules/types_InitDelegate.html index ab50f49..160b9ce 100644 --- a/modules/types_InitDelegate.html +++ b/modules/types_InitDelegate.html @@ -1,2 +1,2 @@ -types/InitDelegate | ts-injex - v0.0.11

    Module types/InitDelegate

    Index

    Type Aliases

    InitDelegate -

    Settings

    Member Visibility
    +types/InitDelegate | ts-injex - v0.0.12

    Module types/InitDelegate

    Index

    Type Aliases

    InitDelegate +

    Settings

    Member Visibility
    diff --git a/types/types_GenericContructor.ForceConstructor.html b/types/types_GenericContructor.ForceConstructor.html index 75517d8..aab9bab 100644 --- a/types/types_GenericContructor.ForceConstructor.html +++ b/types/types_GenericContructor.ForceConstructor.html @@ -1,3 +1,3 @@ -ForceConstructor | ts-injex - v0.0.11

    Type Alias ForceConstructor<T>

    ForceConstructor<T>: (new (...args: unknown[]) => T)

    Force generic constructor type. +ForceConstructor | ts-injex - v0.0.12

    Type Alias ForceConstructor<T>

    ForceConstructor<T>: (new (...args: unknown[]) => T)

    Force generic constructor type. This type is used to force a class to has a constructor.

    -

    Type Parameters

    • T

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/types/types_GenericContructor.GenericConstructor.html b/types/types_GenericContructor.GenericConstructor.html index 82516b4..ccbfced 100644 --- a/types/types_GenericContructor.GenericConstructor.html +++ b/types/types_GenericContructor.GenericConstructor.html @@ -1,3 +1,3 @@ -GenericConstructor | ts-injex - v0.0.11

    Type Alias GenericConstructor<T>

    GenericConstructor<T>: (new (...args: ConstructorParameters<T>) => T)

    Generic constructor type. +GenericConstructor | ts-injex - v0.0.12

    Type Alias GenericConstructor<T>

    GenericConstructor<T>: (new (...args: ConstructorParameters<T>) => T)

    Generic constructor type. This type is used to define a constructor of a class.

    -

    Type Parameters

    • T extends (abstract new (...args: unknown[]) => InstanceType<T>)

    Settings

    Member Visibility
    +

    Type Parameters

    • T extends (abstract new (...args: unknown[]) => InstanceType<T>)

    Settings

    Member Visibility
    diff --git a/types/types_Identifier.Identifier.html b/types/types_Identifier.Identifier.html index ef04faf..b38a366 100644 --- a/types/types_Identifier.Identifier.html +++ b/types/types_Identifier.Identifier.html @@ -1,4 +1,4 @@ -Identifier | ts-injex - v0.0.11

    Type Alias Identifier

    Identifier: string

    The dependency identifier. +Identifier | ts-injex - v0.0.12

    Type Alias Identifier

    Identifier: string

    The dependency identifier. You can use any string as identifier. To create order, it is also possible to provide these with a separator: GroupA.ClassZ. @@ -6,4 +6,4 @@ The convection for naming is as follows: The name should generally correspond to the interface that is relevant. I.e. a class ClassA that implements the interface IClassA and is registered as a dependent class is registered under the interface name IClassA.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/types_InitDelegate.InitDelegate.html b/types/types_InitDelegate.InitDelegate.html index 55267f5..3339680 100644 --- a/types/types_InitDelegate.InitDelegate.html +++ b/types/types_InitDelegate.InitDelegate.html @@ -1,7 +1,7 @@ -InitDelegate | ts-injex - v0.0.11

    Type Alias InitDelegate<T, U>

    InitDelegate<T, U>: ((x: T) => U)

    A function type representing an initializer that transforms an input of type T +InitDelegate | ts-injex - v0.0.12

    Type Alias InitDelegate<T, U>

    InitDelegate<T, U>: ((x: T) => U)

    A function type representing an initializer that transforms an input of type T into an output of type U.

    Type Parameters

    • T

      The type of the input parameter.

    • U

      The type of the output parameter.

    Type declaration

      • (x): U

      • Parameters

        • x: T

          The input parameter of type T.

        Returns U

        The transformed output of type U.

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility