Class NeuronContainer`Experimental`

NeuronContainer is a flexible and performant dependency injection system. Supports aliasing, hybrid string/class tokens, async registration, and lifecycles.

Lifecycle Types:

Singleton: Shared instance for entire app lifetime.
Transient: New instance on every request.
Scoped: New instance per logical scope/request.

This is an experimental feature.

Version

0.5.1

Since

0.13.0

Index

Constructors

constructor

Methods

checkDependency clearScope clone inspect listDependencies override register registerFactory registerValue resolve use

Constructors

constructor

new NeuronContainer(): NeuronContainer
Experimental
Returns NeuronContainer

Methods

checkDependency

checkDependency(key: string | Function, scopeId?: string): boolean
Experimental
Check status of a dependency in scope or outside of a scope.
Parameters
- key: string | Function
  Key or alias of dependency
- OptionalscopeId: string
  The ID of scope that you want to resolve
Returns boolean
Throw error if something wrong and return true if everything was ok
- Defined in core/DI/NeuronContainer.ts:131

clearScope

clearScope(scopeId: string): void
Experimental
Clear all scoped instances for a specific scope ID.
Parameters
- scopeId: string
  The ID of scope that you want to clear
Returns void
Example
```
container.clearScope(req.id);
```
- Defined in core/DI/NeuronContainer.ts:248

clone

clone(): NeuronContainer
Experimental
Clone the entire container with same dependencies.

Returns NeuronContainer
A clone of current container
Example
```
const testContainer = container.clone();
```
- Defined in core/DI/NeuronContainer.ts:229

inspect

inspect(
    key: string | Function,
):
    | null
    | {
        isFactory: boolean;
        key: string
        | Function;
        lifecycle: Lifecycle;
        resolved: boolean;
    }
Experimental
Inspect metadata of a registered dependency.
Parameters
- key: string | Function
  Key or alias of dependency
Returns
    | null
    | {
        isFactory: boolean;
        key: string
        | Function;
        lifecycle: Lifecycle;
        resolved: boolean;
    }
metadata of dependency
Example
```
container.inspect('db');
```
- Defined in core/DI/NeuronContainer.ts:210

listDependencies

listDependencies(): (string | Function)[]
Experimental
List all registered dependency keys.

Returns (string | Function)[]
Array of dependencies
Example
```
console.log(container.listDependencies());
```
- Defined in core/DI/NeuronContainer.ts:199

override

override<T>(key: string | Function, value: T): void
Experimental
Override a registered dependency with a new singleton and non-factory value.
Type Parameters
- T
Parameters
- key: string | Function
  Key or alias of an exist dependency
- value: T
  value of dependency
Returns void
Example
```
container.override('logger', customLogger);
```
- Defined in core/DI/NeuronContainer.ts:179

register

register<T>(
    keys: string | Function | string[],
    value: T | (() => T | Promise<T>),
    options: { isFactory: boolean; lifecycle?: Lifecycle },
): void
Experimental
Main registration method used internally by value/factory variants.
Type Parameters
- T
Parameters
- keys: string | Function | string[]
  String, array of string or Function key for the dependency
- value: T | (() => T | Promise<T>)
  Value to inject as dependency value
- options: { isFactory: boolean; lifecycle?: Lifecycle }
  Some options for configuring the dependency
Returns void
- Defined in core/DI/NeuronContainer.ts:62

registerFactory

registerFactory<T>(
    keys: string | Function | string[],
    factory: () => T | Promise<T>,
    options?: { lifecycle?: Lifecycle },
): void
Experimental
Register a factory function that creates the dependency (sync or async).
Type Parameters
- T
Parameters
- keys: string | Function | string[]
  String, array of string or Function key for the dependency
- factory: () => T | Promise<T>
  Factory function or something that must run to return the instance of dependency
- options: { lifecycle?: Lifecycle } = {}
  Some options for configuring the dependency
Returns void
Example
```
container.registerFactory('db', () => new DB())
container.registerFactory('auth', async () => await AuthService.build())
```
- Defined in core/DI/NeuronContainer.ts:48

registerValue

registerValue<T>(
    keys: string | Function | string[],
    value: T,
    options?: { lifecycle?: Lifecycle },
): void
Experimental
Register a static value or instance (object, function, class instance).
Type Parameters
- T
Parameters
- keys: string | Function | string[]
  String, array of string or Function key for the dependency
- value: T
  Function, object or instance to register as dependency value
- options: { lifecycle?: Lifecycle } = {}
  Some options for configuring the dependency
Returns void
Example
```
container.registerValue('logger', new Logger())
container.registerValue('config', { port: 3000 })
```
- Defined in core/DI/NeuronContainer.ts:31

resolve

resolve<T>(key: string | Function, scopeId?: string): Promise<T>
Experimental
Resolve a dependency, respecting its lifecycle (singleton, scoped, transient).
Type Parameters
- T
Parameters
- key: string | Function
  Key or alias of dependency
- OptionalscopeId: string
  The ID of scope that you want to resolve
Returns Promise<T>
value or instance of the dependency
Example
```
const logger = await container.resolve('logger')
const auth = await container.resolve('auth', req.id)
```
- Defined in core/DI/NeuronContainer.ts:96

use

use<T>(key: string | Function, scopeId?: string): Promise<T>
Experimental
Shortcut for resolve(), mostly for user-facing code.
Type Parameters
- T
Parameters
- key: string | Function
  Key or alias of dependency
- OptionalscopeId: string
  The ID of scope that you want to resolve
Returns Promise<T>
value or instance of the dependency
Example
```
const db = await container.use(DBService);
```
- Defined in core/DI/NeuronContainer.ts:168

Class NeuronContainerExperimental

Lifecycle Types:

Version

Since

Index

Constructors

Methods

Constructors

constructor

Returns NeuronContainer

Methods

checkDependency

Parameters

Returns boolean

clearScope

Parameters

Returns void

Example

clone

Returns NeuronContainer

Example

inspect

Parameters

Returns | null | { isFactory: boolean; key: string | Function; lifecycle: Lifecycle; resolved: boolean; }

Example

listDependencies

Returns (string | Function)[]

Example

override

Type Parameters

Parameters

Returns void

Example

register

Type Parameters

Parameters

Returns void

registerFactory

Type Parameters

Parameters

Returns void

Example

registerValue

Type Parameters

Parameters

Returns void

Example

resolve

Type Parameters

Parameters

Returns Promise<T>

Example

use

Type Parameters

Parameters

Returns Promise<T>

Example

Settings

On This Page

Class NeuronContainer`Experimental`

Returns
| null
| {
isFactory: boolean;
key: string
| Function;
lifecycle: Lifecycle;
resolved: boolean;
}