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: Identifier

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

    • Optionalinit: true | InitDelegate<T, U>

      Optional an initializer function to transform the dependency before injection or true to instantiate the dependency if it has a constructor.

    • necessary: boolean = true

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

    Returns ((target: unknown, propertyKey: string | symbol) => void)

    The resolved dependency or undefined if the dependency is not necessary and not found, or throws an error if the dependency is necessary and not found.

      • (target, propertyKey): void

      • Parameters

        • target: unknown
        • propertyKey: string | symbol

        Returns void

    See

    Throws

    Only throws errors if the dependency is necessary.

    Throws

    A DependencyResolutionError if the dependency is not found.

    Throws

    A InjectorError if an error occurs during the injection process.

    Throws

    A NoInstantiationMethodError if the dependency does not have a constructor.

    Throws

    An InitializationError if an error occurs during the initialization process.

    Example

    class MyClass {
      @Inject<MyDependency>('MyDependencyIdentifier')
      private myDependency!: MyDependency;
    }

    Example

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

Settings

Member Visibility