Class DiContainer

A lazily compiled container, open until its owner calls close().

Example

const root = new DiContainer({ defaultScope: "singleton", autoRegister: false });
root.register("port", { useValue: 3000 });
root.close();
const port = root.resolve<number>("port");

Since

0.1.0

Implements

IContainer
ResolutionScope

Index

Constructors

constructor

new DiContainer(config: ContainerConfig, parent?: DiContainer): DiContainer
Parameters
- config: ContainerConfig
  Container defaults and optional external resolver
- Optionalparent: DiContainer
  Internal parent when constructing a scope
Returns DiContainer

Since
0.11.0
- Defined in packages/di-plugin/src/container/container.ts:128

Properties

`Internal`localInstances

localInstances: Map<ProviderEntry, unknown> | undefined

Instances of scope-local registrations, allocated on first local resolve.

Since

0.11.0

`Readonly` `Internal`root

root: DiContainer

Internal owner of singleton instances.

`Internal`slots

slots: unknown[] | undefined

Internal slot storage, allocated on first scoped resolution.

Methods

close

close(): void
Validates all providers without instantiation, then closes registration.

Returns void
Nothing

Throws
Listing every graph finding

Since
0.11.0
- Defined in packages/di-plugin/src/container/container.ts:308

createScope

createScope(): IContainer
Creates an independent scope with inherited compiled providers.

Returns IContainer
A child with fresh scoped slots

Since
0.11.0
Implementation of IContainer.createScope
- Defined in packages/di-plugin/src/container/container.ts:254

dispose

dispose(): void | Promise<void>
Runs all owned cleanups in reverse creation order, once. Each asynchronous disposal has a fixed 5000 ms deadline; timeouts are recorded with the provider's name and later disposals still run. A timed-out disposal's later outcome is ignored. Synchronous disposals remain untimed and synchronous.

Returns void | Promise<void>
A promise only when cleanup is asynchronous

Throws
After every cleanup runs, if any failed or timed out

Since
0.11.0
Implementation of IContainer.dispose
- Defined in packages/di-plugin/src/container/container.ts:355

forRequest

forRequest(ctx: IRequestContext): IContainer
Obtains the request-owned scope and schedules its disposal once.
Parameters
- ctx: IRequestContext
  Request context with deferred cleanup
Returns IContainer
The cached scope for this context

Throws
Without ctx.defer; use createTestApp

Since
0.11.0
Implementation of IContainer.forRequest
- Defined in packages/di-plugin/src/container/container.ts:268

has

has(token: ContainerToken): boolean
Reports explicit or external availability without constructing anything.
Parameters
- token: ContainerToken
  Token to inspect
Returns boolean
Whether resolution has a provider

Since
0.11.0
Implementation of IContainer.has
- Defined in packages/di-plugin/src/container/container.ts:243

opaqueTokens

opaqueTokens(): readonly ContainerToken[]
Internal
Internal opaque-factory diagnostics used at bootstrap.

Returns readonly ContainerToken[]
Unchecked factory tokens

Since
0.11.0
- Defined in packages/di-plugin/src/container/container.ts:322

register

register<T>(
    token: ContainerToken<T>,
    provider: Provider<T>,
    options?: ProviderOptions<T>,
): void
Registers a provider while open; a scope may add only new leaf tokens. Singleton registrations on a scope are stored as scoped, so their instances and disposals belong to that scope rather than the root.
Type Parameters
- T
Parameters
- token: ContainerToken<T>
  Identity or string token
- provider: Provider<T>
  Construction recipe
- Optionaloptions: ProviderOptions<T>
  Lifetime and optional cleanup
Returns void
Nothing

Throws
If this container is closed

Throws
If the token already exists in this chain

Since
0.11.0
Implementation of IContainer.register
- Defined in packages/di-plugin/src/container/container.ts:182

resolve

resolve<T>(token: ContainerToken<T>): T
Resolves a token through its compiled graph.
Type Parameters
- T
Parameters
- token: ContainerToken<T>
  Token carrying the expected value type
Returns T
The resolved instance

Throws
If wiring is invalid

Throws
If root resolution reaches a scoped provider or creates a disposable transient outside a singleton dependency graph

Throws
If this scope or its root is disposed

Since
0.11.0
Implementation of IContainer.resolve
- Defined in packages/di-plugin/src/container/container.ts:223

track

track(cleanup: () => void | Promise<void>, token: ContainerToken): void
Internal
Internal ownership hook used only by compiled constructors.
Parameters
- cleanup: () => void | Promise<void>
  Disposal of a just-created instance
- token: ContainerToken
  Provider identity used to name a disposal timeout
Returns void
Nothing

Since
0.11.0
Implementation of ResolutionScope.track
- Defined in packages/di-plugin/src/container/container.ts:339

Class DiContainer

Example

Since

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DiContainer

Since

Properties

InternallocalInstances

Since

Readonly Internalroot

Internalslots

Methods

close

Returns void

Throws

Since

createScope

Returns IContainer

Since

dispose

Returns void | Promise<void>

Throws

Since

forRequest

Parameters

Returns IContainer

Throws

Since

has

Parameters

Returns boolean

Since

opaqueTokens

Returns readonly ContainerToken[]

Since

register

Type Parameters

Parameters

Returns void

Throws

Throws

Since

resolve

Type Parameters

Parameters

Returns T

Throws

Throws

Throws

Since

track

Parameters

Returns void

Since

Settings

On This Page

`Internal`localInstances

`Readonly` `Internal`root

`Internal`slots