DependencyManager | API Documentation

Hierarchy

DependencyManager

Index

Constructors

constructor

Methods

Constructors

constructor

new DependencyManager(options?: IOptions): DependencyManager

- Defined in dependency-manager.d.ts:12
Create an instance of the dependency manager

Parameters
- Optional options: IOptions
Returns DependencyManager

Methods

alias

alias(name: string, alias: string): void

- Defined in dependency-manager.d.ts:42
Add an alias name to a dependency name

throws

{Error} if there is a invalid dependency

Parameters
- name: string
  
  The name of the dependency
- alias: string
  
  The alias name
Returns void

get

get<T>(name: string): T

- Defined in dependency-manager.d.ts:50
Get the instance of dependency

throws

{Error} if the dependencies have not been loaded or the dependency does not exist

Type parameters
- T
Parameters
- name: string
  
  The name of the dependency
Returns T

The dependency instance

load

load(): Promise<void>

- Defined in dependency-manager.d.ts:56
Load all registered dependencies

throws

{Error} if a dependencies does not exist or cannot be loaded

Returns Promise<void>

register

register<T, D>(name: string, factory: function, dependencyNames?: string[]): void

- Defined in dependency-manager.d.ts:26
Register a dependency

throws

{Error} if there is a invalid dependency

Type parameters
- T
- D
Parameters
- name: string
  
  The name of the dependency
- factory: function
  
  The factory function that will create the instance
  - - (deps: D): T
    - Parameters
      - deps: D
      Returns T
- Optional dependencyNames: string[]
  
  An array of dependency names
Returns void

set

set<T>(name: string, instance: T): void

- Defined in dependency-manager.d.ts:34
Set a static instance as a dependency

throws

{Error} if there is a invalid dependency

Type parameters
- T
Parameters
- name: string
  
  The name of the dependency
- instance: T
  
  The instance of the dependency
Returns void

Generated using TypeDoc