From 116d7d8ff04d27b93043573e2865711eb985792e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 16 Aug 2024 10:03:10 +0000 Subject: [PATCH] Deploy documentation and coverage --- classes/TSinjex.TSinjex.html | 14 +++++------ ..._Exceptions.DependencyResolutionError.html | 4 ++-- .../interfaces_Exceptions.TSinjexError.html | 4 ++-- coverage/lcov-report/index.html | 2 +- coverage/lcov-report/src/TSinjex.ts.html | 2 +- .../src/__tests__/IDIContainer.spec.ts.html | 2 +- coverage/lcov-report/src/__tests__/index.html | 2 +- .../src/helper/ImplementsStatic.ts.html | 2 +- coverage/lcov-report/src/helper/index.html | 2 +- coverage/lcov-report/src/index.html | 2 +- .../src/interfaces/Exceptions.ts.html | 2 +- .../lcov-report/src/interfaces/index.html | 2 +- functions/decorators_Inject.Inject.html | 2 +- functions/decorators_Register.Register.html | 2 +- ...ors_RegisterInstance.RegisterInstance.html | 2 +- functions/functions_register.register.html | 4 ++-- functions/functions_resolve.resolve.html | 4 ++-- ...per_ImplementsStatic.ImplementsStatic.html | 2 +- index.html | 24 +++++++++++++++++-- .../interfaces_IDependency.IDependency.html | 6 ++--- interfaces/interfaces_ITSinjex.ITSinjex.html | 14 +++++------ .../interfaces_ITSinjex.ITSinjexRegister.html | 8 +++---- .../interfaces_ITSinjex.ITSinjexResolve.html | 8 +++---- interfaces/interfaces_ITSinjex.ITSinjex_.html | 16 ++++++------- modules/TSinjex.html | 2 +- modules/decorators_Inject.html | 2 +- modules/decorators_Register.html | 2 +- modules/decorators_RegisterInstance.html | 2 +- modules/functions_register.html | 2 +- modules/functions_resolve.html | 2 +- modules/helper_ImplementsStatic.html | 2 +- modules/index.html | 2 +- modules/interfaces_Exceptions.html | 2 +- modules/interfaces_IDependency.html | 2 +- modules/interfaces_ITSinjex.html | 2 +- modules/types_GenericContructor.html | 2 +- modules/types_InitDelegate.html | 2 +- ...es_GenericContructor.ForceConstructor.html | 2 +- ..._GenericContructor.GenericConstructor.html | 2 +- types/types_InitDelegate.InitDelegate.html | 2 +- 40 files changed, 92 insertions(+), 72 deletions(-) diff --git a/classes/TSinjex.TSinjex.html b/classes/TSinjex.TSinjex.html index 06e2f2f..0957d2e 100644 --- a/classes/TSinjex.TSinjex.html +++ b/classes/TSinjex.TSinjex.html @@ -1,5 +1,5 @@ TSinjex | ts-injex - v0.0.9

Class TSinjex

TSInjex: Dependency Injection Container

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_dependencies _instance

Methods

register @@ -8,17 +8,17 @@ register resolve

Constructors

Privateconstructor

Properties

Private Readonly_dependencies

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

Private Static_instance

_instance: TSinjex

Methods

register

Properties

Private Readonly_dependencies

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

Private Static_instance

_instance: TSinjex

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

    -

StaticgetInstance

StaticgetInstance

Staticregister

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

  • Type Parameters

    • T

    Parameters

    • identifier: string
    • dependency: T
    • deprecated: boolean = false

    Returns void

    Inherit Doc

    See

    ITSinjex.register

    -

Staticresolve

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

  • Type Parameters

    • T

    Parameters

    • identifier: string
    • necessary: boolean = true

    Returns undefined | T

    Inherit Doc

    See

    ITSinjex.resolve

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Staticregister

Staticresolve

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/interfaces_Exceptions.DependencyResolutionError.html b/classes/interfaces_Exceptions.DependencyResolutionError.html index 41e7588..fd26b9a 100644 --- a/classes/interfaces_Exceptions.DependencyResolutionError.html +++ b/classes/interfaces_Exceptions.DependencyResolutionError.html @@ -1,6 +1,6 @@ DependencyResolutionError | ts-injex - v0.0.9

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
diff --git a/classes/interfaces_Exceptions.TSinjexError.html b/classes/interfaces_Exceptions.TSinjexError.html index 60e3287..477018a 100644 --- a/classes/interfaces_Exceptions.TSinjexError.html +++ b/classes/interfaces_Exceptions.TSinjexError.html @@ -1,5 +1,5 @@ TSinjexError | ts-injex - v0.0.9

Class TSinjexError

General error class for ITSinjex interface.

-

Hierarchy (view full)

Constructors

constructor +

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
diff --git a/coverage/lcov-report/index.html b/coverage/lcov-report/index.html index aa6c5bc..ffbe58a 100644 --- a/coverage/lcov-report/index.html +++ b/coverage/lcov-report/index.html @@ -146,7 +146,7 @@
Code coverage generated by istanbul - at 2024-08-16T09:45:30.759Z + at 2024-08-16T10:03:07.161Z

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
+

Settings

Member Visibility
diff --git a/index.html b/index.html index 0d2d48f..67b011d 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,24 @@ -ts-injex - v0.0.9

ts-injex - v0.0.9

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`
    ],
};
+ts-injex - v0.0.9
ts-injex - v0.0.9
Project Time
Time

+
Test Coverage
Coverage Report..

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatementsBranchesFunctionsLines
StatementsBranchesFunctionsLines

+
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 566350b..a0a0da8 100644 --- a/interfaces/interfaces_IDependency.IDependency.html +++ b/interfaces/interfaces_IDependency.IDependency.html @@ -1,7 +1,7 @@ IDependency | ts-injex - v0.0.9

Interface IDependency

Dependency Entry Interface

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

Properties

dependency +
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 73f3eef..2e5bd87 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjex.html +++ b/interfaces/interfaces_ITSinjex.ITSinjex.html @@ -1,30 +1,30 @@ ITSinjex | ts-injex - v0.0.9

Interface ITSinjex

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

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

      Error 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 b2dbd74..16a099a 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjexRegister.html +++ b/interfaces/interfaces_ITSinjex.ITSinjexRegister.html @@ -1,16 +1,16 @@ ITSinjexRegister | ts-injex - v0.0.9

    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 +
    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 5c7846d..810aa2a 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjexResolve.html +++ b/interfaces/interfaces_ITSinjex.ITSinjexResolve.html @@ -1,16 +1,16 @@ ITSinjexResolve | ts-injex - v0.0.9

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

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

      Error 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 31d0bd2..3cf8446 100644 --- a/interfaces/interfaces_ITSinjex.ITSinjex_.html +++ b/interfaces/interfaces_ITSinjex.ITSinjex_.html @@ -1,32 +1,32 @@ ITSinjex_ | ts-injex - v0.0.9

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

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

      Error 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/TSinjex.html b/modules/TSinjex.html index 95b2b59..6891970 100644 --- a/modules/TSinjex.html +++ b/modules/TSinjex.html @@ -1,2 +1,2 @@ -TSinjex | ts-injex - v0.0.9

    Module TSinjex

    Index

    Classes

    TSinjex +TSinjex | ts-injex - v0.0.9

    Module TSinjex

    Index

    Classes

    TSinjex

    Settings

    Member Visibility
    diff --git a/modules/decorators_Inject.html b/modules/decorators_Inject.html index 92b7eca..3a05eeb 100644 --- a/modules/decorators_Inject.html +++ b/modules/decorators_Inject.html @@ -1,2 +1,2 @@ -decorators/Inject | ts-injex - v0.0.9

    Module decorators/Inject

    Index

    Functions

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

    Module decorators/Inject

    Index

    Functions

    Inject

    Settings

    Member Visibility
    diff --git a/modules/decorators_Register.html b/modules/decorators_Register.html index 03f831d..d323157 100644 --- a/modules/decorators_Register.html +++ b/modules/decorators_Register.html @@ -1,2 +1,2 @@ -decorators/Register | ts-injex - v0.0.9

    Module decorators/Register

    Index

    Functions

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

    Module decorators/Register

    Index

    Functions

    Register

    Settings

    Member Visibility
    diff --git a/modules/decorators_RegisterInstance.html b/modules/decorators_RegisterInstance.html index b9c8489..5a0e356 100644 --- a/modules/decorators_RegisterInstance.html +++ b/modules/decorators_RegisterInstance.html @@ -1,2 +1,2 @@ -decorators/RegisterInstance | ts-injex - v0.0.9

    Module decorators/RegisterInstance

    Index

    Functions

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

    Module decorators/RegisterInstance

    Index

    Functions

    RegisterInstance

    Settings

    Member Visibility
    diff --git a/modules/functions_register.html b/modules/functions_register.html index c6a20fe..74281d9 100644 --- a/modules/functions_register.html +++ b/modules/functions_register.html @@ -1,2 +1,2 @@ -functions/register | ts-injex - v0.0.9

    Module functions/register

    Index

    Functions

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

    Module functions/register

    Index

    Functions

    register

    Settings

    Member Visibility
    diff --git a/modules/functions_resolve.html b/modules/functions_resolve.html index b56c776..68b9aef 100644 --- a/modules/functions_resolve.html +++ b/modules/functions_resolve.html @@ -1,2 +1,2 @@ -functions/resolve | ts-injex - v0.0.9

    Module functions/resolve

    Index

    Functions

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

    Module functions/resolve

    Index

    Functions

    resolve

    Settings

    Member Visibility
    diff --git a/modules/helper_ImplementsStatic.html b/modules/helper_ImplementsStatic.html index 9bfa26d..aa6f7b9 100644 --- a/modules/helper_ImplementsStatic.html +++ b/modules/helper_ImplementsStatic.html @@ -1,2 +1,2 @@ -helper/ImplementsStatic | ts-injex - v0.0.9

    Module helper/ImplementsStatic

    Index

    Functions

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

    Module helper/ImplementsStatic

    Index

    Functions

    ImplementsStatic

    Settings

    Member Visibility
    diff --git a/modules/index.html b/modules/index.html index e2a2640..2804cea 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | ts-injex - v0.0.9

    Module index

    References

    ForceConstructor +index | ts-injex - v0.0.9

    Module index

    References

    ForceConstructor GenericConstructor ITSinjex ITSinjexRegister diff --git a/modules/interfaces_Exceptions.html b/modules/interfaces_Exceptions.html index b4db144..a2f6d4e 100644 --- a/modules/interfaces_Exceptions.html +++ b/modules/interfaces_Exceptions.html @@ -1,3 +1,3 @@ -interfaces/Exceptions | ts-injex - v0.0.9

    Module interfaces/Exceptions

    Index

    Classes

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

    Module interfaces/Exceptions

    Index

    Classes

    DependencyResolutionError TSinjexError

    Settings

    Member Visibility
    diff --git a/modules/interfaces_IDependency.html b/modules/interfaces_IDependency.html index f0546c5..b1b9134 100644 --- a/modules/interfaces_IDependency.html +++ b/modules/interfaces_IDependency.html @@ -1,2 +1,2 @@ -interfaces/IDependency | ts-injex - v0.0.9

    Module interfaces/IDependency

    Index

    Interfaces

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

    Module interfaces/IDependency

    Index

    Interfaces

    IDependency

    Settings

    Member Visibility
    diff --git a/modules/interfaces_ITSinjex.html b/modules/interfaces_ITSinjex.html index eef8e00..8710d37 100644 --- a/modules/interfaces_ITSinjex.html +++ b/modules/interfaces_ITSinjex.html @@ -1,4 +1,4 @@ -interfaces/ITSinjex | ts-injex - v0.0.9

    Module interfaces/ITSinjex

    Index

    Interfaces

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

    Module interfaces/ITSinjex

    Index

    Interfaces

    ITSinjex ITSinjexRegister ITSinjexResolve ITSinjex_ diff --git a/modules/types_GenericContructor.html b/modules/types_GenericContructor.html index 934208c..d713c6c 100644 --- a/modules/types_GenericContructor.html +++ b/modules/types_GenericContructor.html @@ -1,3 +1,3 @@ -types/GenericContructor | ts-injex - v0.0.9

    Module types/GenericContructor

    Index

    Type Aliases

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

    Module types/GenericContructor

    Index

    Type Aliases

    ForceConstructor GenericConstructor

    Settings

    Member Visibility
    diff --git a/modules/types_InitDelegate.html b/modules/types_InitDelegate.html index 62d44d1..5c0df98 100644 --- a/modules/types_InitDelegate.html +++ b/modules/types_InitDelegate.html @@ -1,2 +1,2 @@ -types/InitDelegate | ts-injex - v0.0.9

    Module types/InitDelegate

    Index

    Type Aliases

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

    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 4c03418..707aa68 100644 --- a/types/types_GenericContructor.ForceConstructor.html +++ b/types/types_GenericContructor.ForceConstructor.html @@ -1,3 +1,3 @@ ForceConstructor | ts-injex - v0.0.9

    Type Alias ForceConstructor<T>

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

    Force generic constructor type. This type is used to force a class to be 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 bf7f175..e658e35 100644 --- a/types/types_GenericContructor.GenericConstructor.html +++ b/types/types_GenericContructor.GenericConstructor.html @@ -1,2 +1,2 @@ GenericConstructor | ts-injex - v0.0.9

    Type Alias GenericConstructor<T>

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

    Generic constructor type.

    -

    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_InitDelegate.InitDelegate.html b/types/types_InitDelegate.InitDelegate.html index 9ad6804..d820b90 100644 --- a/types/types_InitDelegate.InitDelegate.html +++ b/types/types_InitDelegate.InitDelegate.html @@ -4,4 +4,4 @@ into an output of type U.

  • 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