diff --git a/classes/classes_TSinjex.TSinjex.html b/classes/classes_TSinjex.TSinjex.html index efb5234..77cdee2 100644 --- a/classes/classes_TSinjex.TSinjex.html +++ b/classes/classes_TSinjex.TSinjex.html @@ -1,4 +1,4 @@ -TSinjex | ts-injex - v0.0.10

TSinjex

The main class for the Dependency Injection Container TSinjex.

+TSinjex | ts-injex - v0.0.11

TSinjex

The main class for the Dependency Injection Container TSinjex.

  • 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

Implements

Constructors

Properties

Methods

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

Constructors

Properties

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

The dependencies map.

-
_instance: TSinjex

The singleton instance of the TSinjex class.

-

Methods

Properties

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

The dependencies map.

+
_instance: TSinjex

The singleton instance of the TSinjex class.

+

Methods

  • 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 a dependency

    +

Returns void

  • 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

    A DependencyResolutionError if the dependency is not found and necessary.

    -
+
diff --git a/classes/interfaces_Exceptions.DependencyResolutionError.html b/classes/interfaces_Exceptions.DependencyResolutionError.html index a122c23..9b05775 100644 --- a/classes/interfaces_Exceptions.DependencyResolutionError.html +++ b/classes/interfaces_Exceptions.DependencyResolutionError.html @@ -1,6 +1,6 @@ -DependencyResolutionError | ts-injex - v0.0.10

Error class for dependency resolution errors in ITSinjex.

+DependencyResolutionError | ts-injex - v0.0.11

Error class for dependency resolution errors in ITSinjex.

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Methods

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Returns DependencyResolutionError

Properties

message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

+

Parameters

  • targetObject: object
  • OptionalconstructorOpt: Function

Returns void

diff --git a/classes/interfaces_Exceptions.TSinjexError.html b/classes/interfaces_Exceptions.TSinjexError.html index 4acccf0..4d97baa 100644 --- a/classes/interfaces_Exceptions.TSinjexError.html +++ b/classes/interfaces_Exceptions.TSinjexError.html @@ -1,5 +1,5 @@ -TSinjexError | ts-injex - v0.0.10

General error class for ITSinjex interface.

-

Hierarchy (view full)

Constructors

constructor +TSinjexError | ts-injex - v0.0.11

General error class for ITSinjex interface.

+

Hierarchy (view full)

Constructors

Properties

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

Methods

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Returns TSinjexError

Properties

message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

+

Parameters

Returns void

diff --git a/coverage/badges/badge-branches.svg b/coverage/badges/badge-branches.svg index bcc0d15..d163a6b 100644 --- a/coverage/badges/badge-branches.svg +++ b/coverage/badges/badge-branches.svg @@ -1 +1 @@ -branches: 45%branches45% \ No newline at end of file +branches: 40.9%branches40.9% \ No newline at end of file diff --git a/coverage/badges/badge-lines.svg b/coverage/badges/badge-lines.svg index 4c1908a..6c87982 100644 --- a/coverage/badges/badge-lines.svg +++ b/coverage/badges/badge-lines.svg @@ -1 +1 @@ -lines: 45.26%lines45.26% \ No newline at end of file +lines: 44.32%lines44.32% \ No newline at end of file diff --git a/coverage/badges/badge-statements.svg b/coverage/badges/badge-statements.svg index 6098d3e..299b7ac 100644 --- a/coverage/badges/badge-statements.svg +++ b/coverage/badges/badge-statements.svg @@ -1 +1 @@ -statements: 46.93%statements46.93% \ No newline at end of file +statements: 46%statements46% \ No newline at end of file diff --git a/coverage/coverage-summary.json b/coverage/coverage-summary.json index 38611a6..9cfe1d4 100644 --- a/coverage/coverage-summary.json +++ b/coverage/coverage-summary.json @@ -1,10 +1,10 @@ -{"total": {"lines":{"total":95,"covered":43,"skipped":0,"pct":45.26},"statements":{"total":98,"covered":46,"skipped":0,"pct":46.93},"functions":{"total":29,"covered":17,"skipped":0,"pct":58.62},"branches":{"total":20,"covered":9,"skipped":0,"pct":45},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}} +{"total": {"lines":{"total":97,"covered":43,"skipped":0,"pct":44.32},"statements":{"total":100,"covered":46,"skipped":0,"pct":46},"functions":{"total":29,"covered":17,"skipped":0,"pct":58.62},"branches":{"total":22,"covered":9,"skipped":0,"pct":40.9},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}} ,"/home/runner/work/TSinjex/TSinjex/src/index.ts": {"lines":{"total":6,"covered":0,"skipped":0,"pct":0},"functions":{"total":0,"covered":0,"skipped":0,"pct":100},"statements":{"total":6,"covered":0,"skipped":0,"pct":0},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}} ,"/home/runner/work/TSinjex/TSinjex/src/__tests__/IDIContainer.spec.ts": {"lines":{"total":19,"covered":19,"skipped":0,"pct":100},"functions":{"total":7,"covered":7,"skipped":0,"pct":100},"statements":{"total":20,"covered":20,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}} ,"/home/runner/work/TSinjex/TSinjex/src/classes/TSinjex.ts": {"lines":{"total":19,"covered":16,"skipped":0,"pct":84.21},"functions":{"total":6,"covered":6,"skipped":0,"pct":100},"statements":{"total":21,"covered":18,"skipped":0,"pct":85.71},"branches":{"total":11,"covered":9,"skipped":0,"pct":81.81}} ,"/home/runner/work/TSinjex/TSinjex/src/decorators/Inject.ts": {"lines":{"total":16,"covered":0,"skipped":0,"pct":0},"functions":{"total":4,"covered":0,"skipped":0,"pct":0},"statements":{"total":16,"covered":0,"skipped":0,"pct":0},"branches":{"total":5,"covered":0,"skipped":0,"pct":0}} ,"/home/runner/work/TSinjex/TSinjex/src/decorators/Register.ts": {"lines":{"total":5,"covered":0,"skipped":0,"pct":0},"functions":{"total":2,"covered":0,"skipped":0,"pct":0},"statements":{"total":5,"covered":0,"skipped":0,"pct":0},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}} -,"/home/runner/work/TSinjex/TSinjex/src/decorators/RegisterInstance.ts": {"lines":{"total":16,"covered":0,"skipped":0,"pct":0},"functions":{"total":4,"covered":0,"skipped":0,"pct":0},"statements":{"total":16,"covered":0,"skipped":0,"pct":0},"branches":{"total":4,"covered":0,"skipped":0,"pct":0}} +,"/home/runner/work/TSinjex/TSinjex/src/decorators/RegisterInstance.ts": {"lines":{"total":18,"covered":0,"skipped":0,"pct":0},"functions":{"total":4,"covered":0,"skipped":0,"pct":0},"statements":{"total":18,"covered":0,"skipped":0,"pct":0},"branches":{"total":6,"covered":0,"skipped":0,"pct":0}} ,"/home/runner/work/TSinjex/TSinjex/src/functions/register.ts": {"lines":{"total":3,"covered":0,"skipped":0,"pct":0},"functions":{"total":1,"covered":0,"skipped":0,"pct":0},"statements":{"total":3,"covered":0,"skipped":0,"pct":0},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}} ,"/home/runner/work/TSinjex/TSinjex/src/functions/resolve.ts": {"lines":{"total":3,"covered":0,"skipped":0,"pct":0},"functions":{"total":1,"covered":0,"skipped":0,"pct":0},"statements":{"total":3,"covered":0,"skipped":0,"pct":0},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}} ,"/home/runner/work/TSinjex/TSinjex/src/helper/ImplementsStatic.ts": {"lines":{"total":2,"covered":2,"skipped":0,"pct":100},"functions":{"total":2,"covered":2,"skipped":0,"pct":100},"statements":{"total":2,"covered":2,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}} diff --git a/coverage/lcov-report/index.html b/coverage/lcov-report/index.html index 871f366..fed9bbe 100644 --- a/coverage/lcov-report/index.html +++ b/coverage/lcov-report/index.html @@ -23,16 +23,16 @@
- 46.93% + 46% Statements - 46/98 + 46/100
- 45% + 40.9% Branches - 9/20 + 9/22
@@ -44,9 +44,9 @@
- 45.26% + 44.32% Lines - 43/95 + 43/97
@@ -129,13 +129,13 @@
0% - 0/37 + 0/39 0% - 0/9 + 0/11 0% 0/10 0% - 0/37 + 0/39 @@ -191,7 +191,7 @@
  • A decorator to inject a dependency from a DI (Dependency Injection) container into a class property.

    +Inject | ts-injex - v0.0.11
    • 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.<
        class MyClass {
        @Inject('ILogger_', (x: ILogger_) => x.getLogger('Tags'), false)
        private _logger?: ILogger;
        }
        -
    +
diff --git a/functions/decorators_Register.Register.html b/functions/decorators_Register.Register.html index 932687d..a0c8ebd 100644 --- a/functions/decorators_Register.Register.html +++ b/functions/decorators_Register.Register.html @@ -1,4 +1,4 @@ -Register | ts-injex - v0.0.10
  • A decorator to register a class in the TSinjex DI (Dependency Injection) container.

    +Register | ts-injex - v0.0.11
    • 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.

        @Register('MyClassIdentifier')
        class MyClass {
        // ...
        }
        -
    +
diff --git a/functions/decorators_RegisterInstance.RegisterInstance.html b/functions/decorators_RegisterInstance.RegisterInstance.html index e8ed2ad..011ae16 100644 --- a/functions/decorators_RegisterInstance.RegisterInstance.html +++ b/functions/decorators_RegisterInstance.RegisterInstance.html @@ -1,4 +1,4 @@ -RegisterInstance | ts-injex - v0.0.10
  • A decorator to register an instance of a class in the DI (Dependency Injection) container.

    +RegisterInstance | ts-injex - v0.0.11
    • 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.

        @RegisterInstance('MyClassInstanceIdentifier', (constructor) => new constructor())
        class MyClass {
        // ...
        }
        -
    +
diff --git a/functions/functions_register.register.html b/functions/functions_register.register.html index 3c82fbe..5e9d8a6 100644 --- a/functions/functions_register.register.html +++ b/functions/functions_register.register.html @@ -1,4 +1,4 @@ -register | ts-injex - v0.0.10

Register a dependency.

+register | ts-injex - v0.0.11

Register a dependency.

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

Identifier for more information on identifiers.

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

Identifier for more information on identifiers..

-
  • Register a dependency.

    +
  • 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

    Identifier for more information on identifiers.

    -
  • +
    diff --git a/functions/functions_resolve.resolve.html b/functions/functions_resolve.resolve.html index c3775c4..ffcb2e3 100644 --- a/functions/functions_resolve.resolve.html +++ b/functions/functions_resolve.resolve.html @@ -1,4 +1,4 @@ -resolve | ts-injex - v0.0.10

    Resolve a dependency.

    +resolve | ts-injex - v0.0.11

    Resolve a dependency.

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

    Identifier for more information on identifiers.

    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.

    Identifier for more information on identifiers.

    A DependencyResolutionError if the dependency is not found.

    -
  • Resolve a dependency

    +
  • 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.

    Identifier for more information on identifiers.

    -
  • +
    diff --git a/functions/helper_ImplementsStatic.ImplementsStatic.html b/functions/helper_ImplementsStatic.ImplementsStatic.html index 42ff8da..eabd525 100644 --- a/functions/helper_ImplementsStatic.ImplementsStatic.html +++ b/functions/helper_ImplementsStatic.ImplementsStatic.html @@ -1,4 +1,4 @@ -ImplementsStatic | ts-injex - v0.0.10
    • Decorator to enforce static implementation of an interface. +ImplementsStatic | ts-injex - v0.0.11

      • 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

      +
        • <T>(constructor, ...args): void
        • Type Parameters

          • T

          Parameters

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

          Returns void

    diff --git a/hierarchy.html b/hierarchy.html index 3124074..23aceae 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -ts-injex - v0.0.10

    ts-injex - v0.0.10

    Class Hierarchy

    +ts-injex - v0.0.11

    ts-injex - v0.0.11

    Class Hierarchy

    diff --git a/index.html b/index.html index 7d63122..a7e5437 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -ts-injex - v0.0.10

    ts-injex - v0.0.10

    Time

    +ts-injex - v0.0.11

    ts-injex - v0.0.11

    Time

    Statements Branches Functions Lines

    TSinjex

    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`
    ],
    };
    -
    +
    diff --git a/interfaces/interfaces_IDependency.IDependency.html b/interfaces/interfaces_IDependency.IDependency.html index 33f075e..d151b46 100644 --- a/interfaces/interfaces_IDependency.IDependency.html +++ b/interfaces/interfaces_IDependency.IDependency.html @@ -1,7 +1,7 @@ -IDependency | ts-injex - v0.0.10

    Dependency Entry Interface

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

    Properties

    dependency +IDependency | ts-injex - v0.0.11

    Dependency Entry Interface

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

    Properties

    dependency: unknown

    The dependency itself

    -
    deprecated?: boolean

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

    deprecated?: boolean

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

    -
    +
    diff --git a/interfaces/interfaces_ITSinjex.ITSinjex.html b/interfaces/interfaces_ITSinjex.ITSinjex.html index 48cd23b..fa7450e 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjex.html +++ b/interfaces/interfaces_ITSinjex.ITSinjex.html @@ -1,31 +1,31 @@ -ITSinjex | ts-injex - v0.0.10

    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.11

    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 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 a deprecated dependency.

      +

    Returns 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 a dependency.

    +
  • Returns 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 a dependency

      +

    Returns void

    • 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

      A DependencyResolutionError if the dependency is not found and necessary.

      -
    • Resolve a necessary dependency.

      +
    • 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.

      A DependencyResolutionError if the dependency is not found.

      -
    • Resolve a non necessary dependency

      +
    • 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

      -
    +
    diff --git a/interfaces/interfaces_ITSinjex.ITSinjexRegister.html b/interfaces/interfaces_ITSinjex.ITSinjexRegister.html index 1f8edb2..aa21305 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjexRegister.html +++ b/interfaces/interfaces_ITSinjex.ITSinjexRegister.html @@ -1,16 +1,16 @@ -ITSinjexRegister | ts-injex - v0.0.10

    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.11

    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

    Methods

    • 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 a deprecated dependency.

      +

    Returns 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 a dependency.

    +
  • Returns 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

  • +

    Returns void

    diff --git a/interfaces/interfaces_ITSinjex.ITSinjexResolve.html b/interfaces/interfaces_ITSinjex.ITSinjexResolve.html index f76ddf1..dfde747 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjexResolve.html +++ b/interfaces/interfaces_ITSinjex.ITSinjexResolve.html @@ -1,17 +1,17 @@ -ITSinjexResolve | ts-injex - v0.0.10

    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.11

    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

    Methods

    • 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

      A DependencyResolutionError if the dependency is not found and necessary.

      -
    • Resolve a necessary dependency.

      +
    • 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.

      A DependencyResolutionError if the dependency is not found.

      -
    • Resolve a non necessary dependency

      +
    • 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

      -
    +
    diff --git a/interfaces/interfaces_ITSinjex.ITSinjex_.html b/interfaces/interfaces_ITSinjex.ITSinjex_.html index df075f4..aa59a5d 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjex_.html +++ b/interfaces/interfaces_ITSinjex.ITSinjex_.html @@ -1,34 +1,34 @@ -ITSinjex_ | ts-injex - v0.0.10

    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.11

    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

    • 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 a deprecated dependency.

      +

    Returns 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 a dependency.

    +
  • Returns 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 a dependency

      +

    Returns void

    • 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

      A DependencyResolutionError if the dependency is not found and necessary.

      -
    • Resolve a necessary dependency.

      +
    • 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.

      A DependencyResolutionError if the dependency is not found.

      -
    • Resolve a non necessary dependency

      +
    • 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

      -
    +
    diff --git a/modules/classes_TSinjex.html b/modules/classes_TSinjex.html index 8885215..0ea3792 100644 --- a/modules/classes_TSinjex.html +++ b/modules/classes_TSinjex.html @@ -1,2 +1,2 @@ -classes/TSinjex | ts-injex - v0.0.10

    Module classes/TSinjex

    Index

    Classes

    +classes/TSinjex | ts-injex - v0.0.11

    Module classes/TSinjex

    Index

    Classes

    diff --git a/modules/decorators_Inject.html b/modules/decorators_Inject.html index add8f0c..83e4ef0 100644 --- a/modules/decorators_Inject.html +++ b/modules/decorators_Inject.html @@ -1,2 +1,2 @@ -decorators/Inject | ts-injex - v0.0.10

    Module decorators/Inject

    Index

    Functions

    +decorators/Inject | ts-injex - v0.0.11

    Module decorators/Inject

    Index

    Functions

    diff --git a/modules/decorators_Register.html b/modules/decorators_Register.html index c46893c..cd74739 100644 --- a/modules/decorators_Register.html +++ b/modules/decorators_Register.html @@ -1,2 +1,2 @@ -decorators/Register | ts-injex - v0.0.10

    Module decorators/Register

    Index

    Functions

    +decorators/Register | ts-injex - v0.0.11

    Module decorators/Register

    Index

    Functions

    diff --git a/modules/decorators_RegisterInstance.html b/modules/decorators_RegisterInstance.html index 5f593d0..a2dea1f 100644 --- a/modules/decorators_RegisterInstance.html +++ b/modules/decorators_RegisterInstance.html @@ -1,2 +1,2 @@ -decorators/RegisterInstance | ts-injex - v0.0.10

    Module decorators/RegisterInstance

    Index

    Functions

    +decorators/RegisterInstance | ts-injex - v0.0.11

    Module decorators/RegisterInstance

    Index

    Functions

    diff --git a/modules/functions_register.html b/modules/functions_register.html index 97d6b7d..59e5d74 100644 --- a/modules/functions_register.html +++ b/modules/functions_register.html @@ -1,2 +1,2 @@ -functions/register | ts-injex - v0.0.10

    Module functions/register

    Index

    Functions

    +functions/register | ts-injex - v0.0.11

    Module functions/register

    Index

    Functions

    diff --git a/modules/functions_resolve.html b/modules/functions_resolve.html index b8b8bbe..6b24dfa 100644 --- a/modules/functions_resolve.html +++ b/modules/functions_resolve.html @@ -1,2 +1,2 @@ -functions/resolve | ts-injex - v0.0.10

    Module functions/resolve

    Index

    Functions

    +functions/resolve | ts-injex - v0.0.11

    Module functions/resolve

    Index

    Functions

    diff --git a/modules/helper_ImplementsStatic.html b/modules/helper_ImplementsStatic.html index a4f324a..b86b0a9 100644 --- a/modules/helper_ImplementsStatic.html +++ b/modules/helper_ImplementsStatic.html @@ -1,2 +1,2 @@ -helper/ImplementsStatic | ts-injex - v0.0.10

    Module helper/ImplementsStatic

    Index

    Functions

    +helper/ImplementsStatic | ts-injex - v0.0.11

    Module helper/ImplementsStatic

    Index

    Functions

    diff --git a/modules/index.html b/modules/index.html index c2130d2..25a067e 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | ts-injex - v0.0.10

    Module index

    References

    ForceConstructor +index | ts-injex - v0.0.11

    Module index

    References

    Re-exports ForceConstructor
    Re-exports GenericConstructor
    Re-exports ITSinjex
    Re-exports ITSinjexRegister
    Re-exports ITSinjexResolve
    Re-exports ITSinjex_
    Re-exports InitDelegate
    Re-exports Inject
    Re-exports Register
    Re-exports RegisterInstance
    Re-exports TSinjex
    Re-exports register
    Re-exports resolve
    +

    References

    Re-exports ForceConstructor
    Re-exports GenericConstructor
    Re-exports ITSinjex
    Re-exports ITSinjexRegister
    Re-exports ITSinjexResolve
    Re-exports ITSinjex_
    Re-exports InitDelegate
    Re-exports Inject
    Re-exports Register
    Re-exports RegisterInstance
    Re-exports TSinjex
    Re-exports register
    Re-exports resolve
    diff --git a/modules/interfaces_Exceptions.html b/modules/interfaces_Exceptions.html index 2b5bdd9..c3a9063 100644 --- a/modules/interfaces_Exceptions.html +++ b/modules/interfaces_Exceptions.html @@ -1,3 +1,3 @@ -interfaces/Exceptions | ts-injex - v0.0.10

    Module interfaces/Exceptions

    Index

    Classes

    DependencyResolutionError +interfaces/Exceptions | ts-injex - v0.0.11
    +
    diff --git a/modules/interfaces_IDependency.html b/modules/interfaces_IDependency.html index 4298f0d..d3b032f 100644 --- a/modules/interfaces_IDependency.html +++ b/modules/interfaces_IDependency.html @@ -1,2 +1,2 @@ -interfaces/IDependency | ts-injex - v0.0.10

    Module interfaces/IDependency

    Index

    Interfaces

    +interfaces/IDependency | ts-injex - v0.0.11

    Module interfaces/IDependency

    Index

    Interfaces

    diff --git a/modules/interfaces_ITSinjex.html b/modules/interfaces_ITSinjex.html index dd18828..6948e58 100644 --- a/modules/interfaces_ITSinjex.html +++ b/modules/interfaces_ITSinjex.html @@ -1,5 +1,5 @@ -interfaces/ITSinjex | ts-injex - v0.0.10

    Module interfaces/ITSinjex

    Index

    Interfaces

    ITSinjex +interfaces/ITSinjex | ts-injex - v0.0.11
    +
    diff --git a/modules/types_GenericContructor.html b/modules/types_GenericContructor.html index 4d3ca1d..1fabebd 100644 --- a/modules/types_GenericContructor.html +++ b/modules/types_GenericContructor.html @@ -1,3 +1,3 @@ -types/GenericContructor | ts-injex - v0.0.10

    Module types/GenericContructor

    Index

    Type Aliases

    ForceConstructor +types/GenericContructor | ts-injex - v0.0.11
    +
    diff --git a/modules/types_Identifier.html b/modules/types_Identifier.html index 82dc01b..1141e6a 100644 --- a/modules/types_Identifier.html +++ b/modules/types_Identifier.html @@ -1,2 +1,2 @@ -types/Identifier | ts-injex - v0.0.10

    Module types/Identifier

    Index

    Type Aliases

    +types/Identifier | ts-injex - v0.0.11

    Module types/Identifier

    Index

    Type Aliases

    diff --git a/modules/types_InitDelegate.html b/modules/types_InitDelegate.html index d6e28e0..861a26f 100644 --- a/modules/types_InitDelegate.html +++ b/modules/types_InitDelegate.html @@ -1,2 +1,2 @@ -types/InitDelegate | ts-injex - v0.0.10

    Module types/InitDelegate

    Index

    Type Aliases

    +types/InitDelegate | ts-injex - v0.0.11

    Module types/InitDelegate

    Index

    Type Aliases

    diff --git a/types/types_GenericContructor.ForceConstructor.html b/types/types_GenericContructor.ForceConstructor.html index b447d15..824f167 100644 --- a/types/types_GenericContructor.ForceConstructor.html +++ b/types/types_GenericContructor.ForceConstructor.html @@ -1,3 +1,3 @@ -ForceConstructor | ts-injex - v0.0.10
    ForceConstructor<T>: (new (...args: unknown[]) => T)

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

    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
    +

    Type Parameters

    • T
    diff --git a/types/types_GenericContructor.GenericConstructor.html b/types/types_GenericContructor.GenericConstructor.html index 32136fa..76cf686 100644 --- a/types/types_GenericContructor.GenericConstructor.html +++ b/types/types_GenericContructor.GenericConstructor.html @@ -1,3 +1,3 @@ -GenericConstructor | ts-injex - v0.0.10
    GenericConstructor<T>: (new (...args: ConstructorParameters<T>) => T)

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

    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>)
    +

    Type Parameters

    • T extends (abstract new (...args: unknown[]) => InstanceType<T>)
    diff --git a/types/types_Identifier.Identifier.html b/types/types_Identifier.Identifier.html index a713475..3692512 100644 --- a/types/types_Identifier.Identifier.html +++ b/types/types_Identifier.Identifier.html @@ -1,4 +1,4 @@ -Identifier | ts-injex - v0.0.10
    Identifier: string

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

    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.

    -
    +
    diff --git a/types/types_InitDelegate.InitDelegate.html b/types/types_InitDelegate.InitDelegate.html index e96cbc6..4a5132b 100644 --- a/types/types_InitDelegate.InitDelegate.html +++ b/types/types_InitDelegate.InitDelegate.html @@ -1,7 +1,7 @@ -InitDelegate | ts-injex - v0.0.10

    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.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 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.

        -
    +