Options
All
  • Public
  • Public/Protected
  • All
Menu

The main application container.

Hierarchy

Index

Constructors

constructor

Properties

Protected applicationUnits

applicationUnits: typeof Unit[] = []

The Unit classes registered with the app.

Protected baseDir

baseDir: string

The fully-qualified path to the base directory of the app.

Protected basePath

basePath: UniversalPath

Resolved universal path to the base directory of the app.

Protected factories

factories: Collection<AbstractFactory<unknown>> = ...

Collection of factories registered with this container.

forceStartupMessage

forceStartupMessage: boolean = true

If true, the "Starting Extollo..." messages will always be logged.

Protected instances

instances: Collection<InstanceRef> = ...

Collection of singleton instances produced by this container.

Protected instantiatedUnits

instantiatedUnits: Unit[] = []

Instances of the units registered with this app.

Protected staticOverrides

staticOverrides: Collection<{ base: StaticInstantiable<any>; override: StaticInstantiable<any> }> = ...

Collection of static-class overrides registered with this container.

Protected waitingLifecycleCallbacks

waitingLifecycleCallbacks: Collection<WeakRef<AwareOfContainerLifecycle>> = ...

Collection of created objects that should have lifecycle events called on them, if they still exist.

Protected waitingResolveCallbacks

waitingResolveCallbacks: Collection<{ callback: (t: unknown) => unknown; key: any }> = ...

Collection of callbacks waiting for a dependency key to be resolved.

Static Readonly NODE_MODULES_INJECTION

NODE_MODULES_INJECTION: "extollo/npm" = 'extollo/npm'

Static Protected Optional makeHistory

makeHistory: Collection<any>

The 100 most recent dependency keys that were make'd. Used to help with debugging cyclic dependency errors.

Static Protected Optional makeStack

makeStack: Collection<any>

List of dependency keys currently being make'd as a reverse stack. This is used to detect dependency cycles.

Static Protected realizingContainer

realizingContainer: boolean = false

Set to true when we're realizing a container. Used to prevent infinite recursion when getContainer() is accidentally called from somewhere within the realizeContainer() call.

Accessors

appRoot

errorHandler

  • get errorHandler(): (e: Error) => void
  • Get an instance of the RunLevelErrorHandler.

    Returns (e: Error) => void

      • (e: Error): void
      • Parameters

        • e: Error

        Returns void

root

Static NODE_MODULES_PROVIDER

  • get NODE_MODULES_PROVIDER(): string

Methods

appPath

Protected bootstrapEnvironment

  • bootstrapEnvironment(): void

Protected checkForMakeCycles

  • checkForMakeCycles(): void
  • Check the makeStack for duplicates and throw an error if a dependency cycle is detected. This is used to prevent infinite mutual recursion when cyclic dependencies occur.

    Returns void

cloneTo

destroy

  • destroy(): void

down

  • down(): Promise<void>

env

  • env(key: string, defaultValue?: unknown): any
  • Get a value from the loaded environment variables. If no value could be found, the default value will be returned.

    Parameters

    • key: string
    • Optional defaultValue: unknown

    Returns any

errorWrapContext

getDependencies

getExistingInstance

  • getExistingInstance(key: any): any

getStaticOverride

hasInstance

  • hasInstance(key: any): boolean

hasKey

  • hasKey(key: any): boolean

hasStaticOverride

hasUnit

  • hasUnit(unitClass: typeof Unit): boolean

make

  • make<T>(target: any, ...parameters: any[]): T
  • Create an instance of the given target. The target can either be a DependencyKey registered with this container (in which case, the singleton value will be returned), or an instantiable class.

    If the instantiable class has the Injectable decorator, its injectable parameters will be automatically injected into the instance.

    Type parameters

    • T

    Parameters

    • target: any
    • Rest ...parameters: any[]

    Returns T

makeByStaticOverride

makeNew

  • makeNew<T>(key: any, ...parameters: any[]): T
  • Create a new instance of the dependency key using this container, ignoring any pre-existing instances in this container.

    Type parameters

    • T

    Parameters

    • key: any
    • Rest ...parameters: any[]

    Returns T

onResolve

  • onResolve<T>(key: any): Promise<T>
  • Get a Promise that resolves the first time the given dependency key is resolved by the application. If it has already been resolved, the Promise will resolve immediately.

    Type parameters

    • T

    Parameters

    • key: any

    Returns Promise<T>

path

Protected produceFactory

purge

register

registerFactory

registerNamed

registerProducer

  • registerProducer(name: any, producer: () => any): Application
  • Register the given function as a factory within the container.

    Parameters

    • name: any

      unique name to identify the factory in the container

    • producer: () => any

      factory to produce a value

        • (): any
        • Returns any

    Returns Application

registerSingleton

  • registerSingleton<T>(key: any, value: T): Application
  • Register a value as a singleton in the container. It will not be instantiated, but can be injected by its unique name.

    Type parameters

    • T

    Parameters

    • key: any

      unique name to identify the singleton in the container

    • value: T

    Returns Application

registerSingletonInstance

  • registerSingletonInstance<T>(staticClass: any, instance: T): Application

registerStaticOverride

release

resolve

resolveAndCreate

  • resolveAndCreate(key: any, ...parameters: any[]): any
  • Resolve the dependency key. If a singleton value for that key already exists in this container, return that value. Otherwise, use the factory an given parameters to produce and return the value.

    Parameters

    • key: any
    • Rest ...parameters: any[]

    Returns any

run

  • run(): Promise<void>

scaffold

  • scaffold(absolutePathToApplicationRoot: string, applicationUnits: typeof Unit[]): void
  • Set up the bare essentials to get the application up and running.

    Parameters

    • absolutePathToApplicationRoot: string
    • applicationUnits: typeof Unit[]

    Returns void

Protected setupLogging

  • setupLogging(): void

startUnit

  • startUnit(unit: Unit): Promise<void>

stopUnit

  • stopUnit(unit: Unit): Promise<void>

up

  • up(): Promise<void>

Static getApplication

Static getContainer

Static realizeContainer

  • realizeContainer<T>(container: T): T
Extollo Logo

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.