Interface Container

Container API.

interface Container {
    isDisposed: boolean;
    options: ContainerOptions;
    parent: undefined | Container;
    clearCache(): unknown[];
    createChild(options?: Partial<ContainerOptions>): Container;
    dispose(): void;
    getAllCached<Value>(token: Token<Value>): Value[];
    getCached<Value>(token: Token<Value>): undefined | Value;
    isRegistered(token: Type<any> | Constructor<any>): boolean;
    register<Instance extends object>(Class: Constructor<Instance>): Container;
    register<Instance extends object, ProviderInstance extends object>(
        token: Token<Instance>,
        provider: ClassProvider<ProviderInstance>,
        options?: RegistrationOptions,
    ): Container;
    register<Value, ProviderValue>(
        token: Token<Value>,
        provider: FactoryProvider<ProviderValue>,
        options?: RegistrationOptions,
    ): Container;
    register<Value, ProviderValue>(
        token: Token<Value>,
        provider: ExistingProvider<ProviderValue>,
    ): Container;
    register<Value, ProviderValue>(
        token: Token<Value>,
        provider: ValueProvider<ProviderValue>,
    ): Container;
    registerAlias<Value, ProvidedValue>(
        targetToken: Token<ProvidedValue>,
        aliasTokens: Tokens<Value>,
    ): void;
    registerClass<Instance extends object>(Class: Constructor<Instance>): void;
    registerClass<Instance extends object, ProvidedInstance extends object>(
        token: Token<Instance>,
        Class: Constructor<ProvidedInstance>,
        options?: RegistrationOptions,
    ): void;
    registerFactory<Value, ProvidedValue>(
        token: Token<Value>,
        factory: (...args: []) => ProvidedValue,
        options?: RegistrationOptions,
    ): void;
    registerValue<Value, ProvidedValue>(
        token: Token<Value>,
        value: ProvidedValue,
    ): void;
    resetRegistry(): unknown[];
    resolve<Instance extends object>(
        Class: Constructor<Instance>,
        optional?: false,
    ): Instance;
    resolve<Instance extends object>(
        Class: Constructor<Instance>,
        optional: true,
    ): undefined | Instance;
    resolve<Instance extends object>(
        Class: Constructor<Instance>,
        optional?: boolean,
    ): undefined | Instance;
    resolve<Value>(token: Token<Value>, optional?: false): Value;
    resolve<Value>(token: Token<Value>, optional: true): undefined | Value;
    resolve<Value>(token: Token<Value>, optional?: boolean): undefined | Value;
    resolveAll<Instance extends object>(
        Class: Constructor<Instance>,
        optional?: false,
    ): Instance[];
    resolveAll<Instance extends object>(
        Class: Constructor<Instance>,
        optional: true,
    ): Instance[];
    resolveAll<Instance extends object>(
        Class: Constructor<Instance>,
        optional?: boolean,
    ): Instance[];
    resolveAll<Value>(
        token: Token<Value>,
        optional?: false,
    ): NonNullable<Value>[];
    resolveAll<Value>(
        token: Token<Value>,
        optional: true,
    ): NonNullable<Value>[];
    resolveAll<Value>(
        token: Token<Value>,
        optional?: boolean,
    ): NonNullable<Value>[];
    unregister<Value>(token: Token<Value>): Value[];
}

Index

Properties

isDisposed options parent

Methods

clearCache createChild dispose getAllCached getCached isRegistered register registerAlias registerClass registerFactory registerValue resetRegistry resolve resolveAll unregister

Properties

`Readonly`isDisposed

isDisposed: boolean

Whether this container is disposed.

`Readonly`options

options: ContainerOptions

The options used to create this container.

`Readonly`parent

parent: undefined | Container

The parent container, or undefined if this is the root container.

Methods

clearCache

clearCache(): unknown[]
Clears and returns all distinct cached values from this container's internal registry. Values from ValueProvider registrations are not included, as they are never cached.

Note that only this container is affected. Parent containers, if any, remain unchanged.

Returns unknown[]
- Defined in container.ts:68

createChild

createChild(options?: Partial<ContainerOptions>): Container
Creates a new child container that inherits this container's options.

You can pass specific options to override the inherited ones.
Parameters
- Optionaloptions: Partial<ContainerOptions>
Returns Container
- Defined in container.ts:60

dispose

dispose(): void
Disposes this container and all its cached values.

Token values implementing a Disposable interface (e.g., objects with a dispose() function) are automatically disposed during this process.

Note that children containers are disposed first, in creation order.

Returns void
- Defined in container.ts:347

getAllCached

getAllCached<Value>(token: Token<Value>): Value[]
Returns all cached values associated with registrations of the token, in the order they were registered, or an empty array if none have been cached.

If the token has at least one registration in the current container, cached values are taken from those registrations. Otherwise, cached values may be retrieved from parent containers, if any.

Values are never cached for tokens with transient or resolution scope, or for ValueProvider registrations.
Type Parameters
- Value
Parameters
- token: Token<Value>
Returns Value[]
- Defined in container.ts:94

getCached

getCached<Value>(token: Token<Value>): undefined | Value
Returns the cached value from the most recent registration of the token, or undefined if no value has been cached yet (the token has not been resolved yet).

If the token has at least one registration in this container, the cached value is taken from the most recent of those registrations. Otherwise, it may be retrieved from parent containers, if any.

Values are never cached for tokens with transient or resolution scope, or for ValueProvider registrations.
Type Parameters
- Value
Parameters
- token: Token<Value>
Returns undefined | Value
- Defined in container.ts:81

isRegistered

isRegistered(token: Type<any> | Constructor<any>): boolean
Returns whether the token is registered in this container or in parent containers, if any.
Parameters
- token: Type<any> | Constructor<any>
Returns boolean
- Defined in container.ts:109

register

register<Instance extends object>(Class: Constructor<Instance>): Container
Registers a ClassProvider, using the class itself as its token.

Tokens provided via the Injectable decorator applied to the class are also registered as aliases.

The scope is determined by the Scoped decorator, if present.
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
Returns Container
See
registerClass
- Defined in container.ts:174
register<Instance extends object, ProviderInstance extends object>(
    token: Token<Instance>,
    provider: ClassProvider<ProviderInstance>,
    options?: RegistrationOptions,
): Container
Registers a ClassProvider with a token.

The default registration scope is determined by the Scoped decorator applied to the provided class, if present, but it can be overridden by passing explicit registration options.
Type Parameters
- Instance extends object
- ProviderInstance extends object
Parameters
- token: Token<Instance>
- provider: ClassProvider<ProviderInstance>
- Optionaloptions: RegistrationOptions
Returns Container
See
registerClass
- Defined in container.ts:185
register<Value, ProviderValue>(
    token: Token<Value>,
    provider: FactoryProvider<ProviderValue>,
    options?: RegistrationOptions,
): Container
Registers a FactoryProvider with a token.
Type Parameters
- Value
- ProviderValue
Parameters
- token: Token<Value>
- provider: FactoryProvider<ProviderValue>
- Optionaloptions: RegistrationOptions
Returns Container
See
registerFactory
- Defined in container.ts:196
register<Value, ProviderValue>(
token: Token<Value>,
provider: ExistingProvider<ProviderValue>,
): Container
Registers an ExistingProvider with a token.

The token will alias the one set in useExisting.
Type Parameters
- Value
- ProviderValue
Parameters
- token: Token<Value>
- provider: ExistingProvider<ProviderValue>
Returns Container
See
registerAlias
- Defined in container.ts:209
register<Value, ProviderValue>(
token: Token<Value>,
provider: ValueProvider<ProviderValue>,
): Container
Registers a ValueProvider with a token.

Values provided via useValue are never cached (scopes do not apply) and are simply returned as-is.
Type Parameters
- Value
- ProviderValue
Parameters
- token: Token<Value>
- provider: ValueProvider<ProviderValue>
Returns Container
See
registerValue
- Defined in container.ts:222

registerAlias

registerAlias<Value, ProvidedValue>(
targetToken: Token<ProvidedValue>,
aliasTokens: Tokens<Value>,
): void
Registers one or more tokens as aliases for a target token.

When an alias is resolved, the target token is resolved instead.
Type Parameters
- Value
- ProvidedValue
Parameters
- targetToken: Token<ProvidedValue>
- aliasTokens: Tokens<Value>
Returns void
- Defined in container.ts:159

registerClass

registerClass<Instance extends object>(Class: Constructor<Instance>): void
Registers a concrete class, where the class acts as its own token.

Tokens provided via the Injectable decorator applied to the class are also registered as aliases.

The default registration scope is determined by the Scoped decorator, if present.
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
Returns void
- Defined in container.ts:120
registerClass<Instance extends object, ProvidedInstance extends object>(
    token: Token<Instance>,
    Class: Constructor<ProvidedInstance>,
    options?: RegistrationOptions,
): void
Registers a concrete class with a token.

The default registration scope is determined by the Scoped decorator applied to the class, if present, but it can be overridden by passing explicit registration options.
Type Parameters
- Instance extends object
- ProvidedInstance extends object
Parameters
- token: Token<Instance>
- Class: Constructor<ProvidedInstance>
- Optionaloptions: RegistrationOptions
Returns void
- Defined in container.ts:129

registerFactory

registerFactory<Value, ProvidedValue>(
    token: Token<Value>,
    factory: (...args: []) => ProvidedValue,
    options?: RegistrationOptions,
): void
Registers a token whose value is produced by a factory function.

The factory function runs inside the injection context and can thus access dependencies via inject-like functions.
Type Parameters
- Value
- ProvidedValue
Parameters
- token: Token<Value>
- factory: (...args: []) => ProvidedValue
- Optionaloptions: RegistrationOptions
Returns void
- Defined in container.ts:141

registerValue

registerValue<Value, ProvidedValue>(
token: Token<Value>,
value: ProvidedValue,
): void
Registers a token with a fixed value.

The provided value is returned as-is when the token is resolved (scopes do not apply).
Type Parameters
- Value
- ProvidedValue
Parameters
- token: Token<Value>
- value: ProvidedValue
Returns void
- Defined in container.ts:152

resetRegistry

resetRegistry(): unknown[]
Removes all registrations from this container's internal registry.

Returns an array of distinct cached values that were stored within the removed registrations. Values from ValueProvider registrations are not included, as they are not cached.

Note that only this container is affected. Parent containers, if any, remain unchanged.

Returns unknown[]
- Defined in container.ts:104

resolve

resolve<Instance extends object>(
Class: Constructor<Instance>,
optional?: false,
): Instance
Resolves the given class to the instance associated with it.

If the class is registered in this container or any of its parent containers, an instance is created using the most recent registration.

If the class is not registered, but it is decorated with AutoRegister, or ContainerOptions.autoRegister is true, the class is registered automatically. Otherwise, resolution fails. The scope for the automatic registration is determined by either the Scoped decorator on the class, or ContainerOptions.defaultScope.

If optional is false or is not passed and the class is not registered in the container (and could not be auto-registered), an error is thrown. Otherwise, if optional is true, undefined is returned.

The resolution behavior depends on the Provider used during registration:
- For ValueProvider, the explicitly provided instance is returned.
- For FactoryProvider, the factory function is invoked to create the instance.
- For ClassProvider, a new instance of the class is created according to its scope.
- For ExistingProvider, the instance is resolved by referring to another registered token.
If the class is registered with container scope, the resolved instance is cached in the container's internal registry.
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
- Optionaloptional: false
Returns Instance
- Defined in container.ts:262
resolve<Instance extends object>(
Class: Constructor<Instance>,
optional: true,
): undefined | Instance
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
- optional: true
Returns undefined | Instance
- Defined in container.ts:263
resolve<Instance extends object>(
Class: Constructor<Instance>,
optional?: boolean,
): undefined | Instance
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
- Optionaloptional: boolean
Returns undefined | Instance
- Defined in container.ts:264
resolve<Value>(token: Token<Value>, optional?: false): Value
Resolves the given token to the value associated with it.

If the token is registered in this container or any of its parent containers, its value is resolved using the most recent registration.

If optional is false or not passed and the token is not registered in the container, an error is thrown. Otherwise, if optional is true, undefined is returned.

The resolution behavior depends on the Provider used during registration:
- For ValueProvider, the explicitly provided value is returned.
- For FactoryProvider, the factory function is invoked to create the value.
- For ClassProvider, a new instance of the class is created according to its scope.
- For ExistingProvider, the value is resolved by referring to another registered token.
If the token is registered with container scope, the resolved value is cached in the container's internal registry.
Type Parameters
- Value
Parameters
- token: Token<Value>
- Optionaloptional: false
Returns Value
- Defined in container.ts:284
resolve<Value>(token: Token<Value>, optional: true): undefined | Value
Type Parameters
- Value
Parameters
- token: Token<Value>
- optional: true
Returns undefined | Value
- Defined in container.ts:285
resolve<Value>(token: Token<Value>, optional?: boolean): undefined | Value
Type Parameters
- Value
Parameters
- token: Token<Value>
- Optionaloptional: boolean
Returns undefined | Value
- Defined in container.ts:286

resolveAll

resolveAll<Instance extends object>(
Class: Constructor<Instance>,
optional?: false,
): Instance[]
Resolves the given class to all instances provided by the registrations associated with it.

If the class is not registered, but it is decorated with AutoRegister, or ContainerOptions.autoRegister is true, the class is registered automatically. Otherwise, resolution fails. The scope for the automatic registration is determined by either the Scoped decorator on the class, or ContainerOptions.defaultScope.

If optional is false or is not passed and the class is not registered in the container (and could not be auto-registered), an error is thrown. Otherwise, if optional is true, an empty array is returned.

The resolution behavior depends on the Provider used during registration:
- For ValueProvider, the explicitly provided instance is returned.
- For FactoryProvider, the factory function is invoked to create the instance.
- For ClassProvider, a new instance of the class is created according to its scope.
- For ExistingProvider, the instance is resolved by referring to another registered token.
If the class is registered with container scope, the resolved instances are cached in the container's internal registry.

A separate instance of the class is created for each provider.
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
- Optionaloptional: false
Returns Instance[]
See
The documentation for resolve(Class: Constructor)
- Defined in container.ts:314
resolveAll<Instance extends object>(
Class: Constructor<Instance>,
optional: true,
): Instance[]
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
- optional: true
Returns Instance[]
- Defined in container.ts:315
resolveAll<Instance extends object>(
Class: Constructor<Instance>,
optional?: boolean,
): Instance[]
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
- Optionaloptional: boolean
Returns Instance[]
- Defined in container.ts:316
resolveAll<Value>(token: Token<Value>, optional?: false): NonNullable<Value>[]
Resolves the given token to all values provided by the registrations associated with it.

If optional is false or not passed and the token is not registered in the container, an error is thrown. Otherwise, if optional is true, an empty array is returned.

The resolution behavior depends on the Provider used during registration:
- For ValueProvider, the explicitly provided value is returned.
- For FactoryProvider, the factory function is invoked to create the value.
- For ClassProvider, a new instance of the class is created according to its scope.
- For ExistingProvider, the value is resolved by referring to another registered token.
If the token is registered with container scope, the resolved values are cached in the container's internal registry.
Type Parameters
- Value
Parameters
- token: Token<Value>
- Optionaloptional: false
Returns NonNullable<Value>[]
See
The documentation for resolve(token: Token)
- Defined in container.ts:335
resolveAll<Value>(token: Token<Value>, optional: true): NonNullable<Value>[]
Type Parameters
- Value
Parameters
- token: Token<Value>
- optional: true
Returns NonNullable<Value>[]
- Defined in container.ts:336
resolveAll<Value>(token: Token<Value>, optional?: boolean): NonNullable<Value>[]
Type Parameters
- Value
Parameters
- token: Token<Value>
- Optionaloptional: boolean
Returns NonNullable<Value>[]
- Defined in container.ts:337

unregister

unregister<Value>(token: Token<Value>): Value[]
Removes all registrations for the given token from the container's internal registry.

Returns an array of distinct cached values that were stored within the removed registrations. Values from ValueProvider registrations are not included, as they are not cached.

Note that only this container is affected. Parent containers, if any, remain unchanged.
Type Parameters
- Value
Parameters
- token: Token<Value>
Returns Value[]
- Defined in container.ts:235

Interface Container

Index

Properties

Methods

Properties

ReadonlyisDisposed

Readonlyoptions

Readonlyparent

Methods

clearCache

Returns unknown[]

createChild

Parameters

Returns Container

dispose

Returns void

getAllCached

Type Parameters

Parameters

Returns Value[]

getCached

Type Parameters

Parameters

Returns undefined | Value

isRegistered

Parameters

Returns boolean

register

Type Parameters

Parameters

Returns Container

See

Type Parameters

Parameters

Returns Container

See

Type Parameters

Parameters

Returns Container

See

Type Parameters

Parameters

Returns Container

See

Type Parameters

Parameters

Returns Container

See

registerAlias

Type Parameters

Parameters

Returns void

registerClass

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

registerFactory

Type Parameters

Parameters

Returns void

registerValue

Type Parameters

Parameters

Returns void

resetRegistry

Returns unknown[]

resolve

Type Parameters

Parameters

Returns Instance

Type Parameters

Parameters

Returns undefined | Instance

Type Parameters

Parameters

Returns undefined | Instance

Type Parameters

`Readonly`isDisposed

`Readonly`options

`Readonly`parent