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.

    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.

    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

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

    Error if the dependency is not found.

  • 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