Interface Injector

Injector API.

interface Injector {
    inject<Instance extends object>(Class: Constructor<Instance>): Instance;
    inject<Value>(token: Token<Value>): Value;
    injectAll<Instance extends object>(
        Class: Constructor<Instance>,
    ): Instance[];
    injectAll<Value>(token: Token<Value>): NonNullable<Value>[];
    optional<Instance extends object>(
        Class: Constructor<Instance>,
    ): undefined | Instance;
    optional<Value>(token: Token<Value>): undefined | Value;
    optionalAll<Instance extends object>(
        Class: Constructor<Instance>,
    ): Instance[];
    optionalAll<Value>(token: Token<Value>): NonNullable<Value>[];
}

Index

Methods

inject injectAll optional optionalAll

Methods

inject

inject<Instance extends object>(Class: Constructor<Instance>): Instance
Injects the instance associated with the given class.

Throws an error if the class is not registered in the container.
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
Returns Instance
- Defined in injector.ts:18
inject<Value>(token: Token<Value>): Value
Injects the value associated with the given token.

Throws an error if the token is not registered in the container.
Type Parameters
- Value
Parameters
- token: Token<Value>
Returns Value
- Defined in injector.ts:25

injectAll

injectAll<Instance extends object>(Class: Constructor<Instance>): Instance[]
Injects all instances provided by the registrations associated with the given class.

Throws an error if the class is not registered in the container.
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
Returns Instance[]
- Defined in injector.ts:32
injectAll<Value>(token: Token<Value>): NonNullable<Value>[]
Injects all values provided by the registrations associated with the given token.

Throws an error if the token is not registered in the container.
Type Parameters
- Value
Parameters
- token: Token<Value>
Returns NonNullable<Value>[]
- Defined in injector.ts:39

optional

optional<Instance extends object>(
Class: Constructor<Instance>,
): undefined | Instance
Injects the instance associated with the given class, or undefined if the class is not registered in the container.
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
Returns undefined | Instance
- Defined in injector.ts:45
optional<Value>(token: Token<Value>): undefined | Value
Injects the value associated with the given token, or undefined if the token is not registered in the container.
Type Parameters
- Value
Parameters
- token: Token<Value>
Returns undefined | Value
- Defined in injector.ts:51

optionalAll

optionalAll<Instance extends object>(Class: Constructor<Instance>): Instance[]
Injects all instances provided by the registrations associated with the given class, or an empty array if the class is not registered in the container.
Type Parameters
- Instance extends object
Parameters
- Class: Constructor<Instance>
Returns Instance[]
- Defined in injector.ts:57
optionalAll<Value>(token: Token<Value>): NonNullable<Value>[]
Injects all values provided by the registrations associated with the given token, or an empty array if the token is not registered in the container.
Type Parameters
- Value
Parameters
- token: Token<Value>
Returns NonNullable<Value>[]
- Defined in injector.ts:63