Class Environment

constructor

• new Environment(options?: EnvironmentOptions): Environment

  Creates a new Environment instance

  Parameters

  • options: EnvironmentOptions = {}

    environment options

  Returns Environment

parent

Staticinstance

created

• created<T>(instance: T): T

  Process a newly created instance

  Type Parameters

  • T

  Parameters

  • instance: T

  Returns T

executeProcessors

• executeProcessors<T>(lifecycle: Lifecycle, instance: T): T

  Execute lifecycle processors on an instance

  Type Parameters

  • T

  Parameters

  • lifecycle: Lifecycle
  • instance: T

  Returns T

executeProcessorsAsync

• executeProcessorsAsync<T>(lifecycle: Lifecycle, instance: T): Promise<T>

  Execute lifecycle processors asynchronously

  Type Parameters

  • T

  Parameters

  • lifecycle: Lifecycle
  • instance: T

  Returns Promise<T>

get

• get<T>(type: new (...args: any[]) => T): T

  Get an instance of the specified type

  Type Parameters

  • T

    the type

  Parameters

  • type: new (...args: any[]) => T

    the desired type

  Returns T

  the instance

getProviders

• getProviders(): Map<any, AbstractInstanceProvider<any>>

  Get providers (for internal use)

  Returns Map<any, AbstractInstanceProvider<any>>

getScope

• getScope(scopeName: string): Scope

  Get a scope by name

  Parameters

  • scopeName: string

  Returns Scope

isRegisteredType

• isRegisteredType(type: any): boolean

  Check if a type is registered

  Parameters

  • type: any

  Returns boolean

registeredTypes

• registeredTypes(predicate: (type: any) => boolean): any[]

  Get all registered types matching a predicate

  Parameters

  • predicate: (type: any) => boolean

  Returns any[]

report

• report(): string

  Generate a report of the environment state

  Returns string

start

• start(): Promise<void>

  Start the environment by executing ON_RUNNING lifecycle phase

  Returns Promise<void>

stop

• stop(): Promise<void>

  Stop the environment by executing ON_DESTROY lifecycle phase

  Returns Promise<void>

supports

• supports(type: new (...args: any[]) => any): boolean

  Parameters

  • type: new (...args: any[]) => any

  Returns boolean

toString

• toString(): string

  Returns string