Class Context

Dependency injection context.

Index

Methods

activate createChildContext findContext get getAsync getParent getSync has isActive remove setClass setFactory setFunction setValue getActive getRoot

Methods

activate

activate(): Context
Activates this dependency injection context so all code which retrieves the context via () work with this context.

Returns Context
The previously active context.
- Defined in Context.ts:91

createChildContext

createChildContext(): Context
Creates a new child dependency injection context. The context is not activated, you have to do this yourself with () if needed.

Returns Context
The created child dependency injection context.
- Defined in Context.ts:75

findContext

findContext(qualifier: Qualifier): null | Context
Returns the context containing the dependency matching the given qualifier. Starts searching with this context and then bubbles up to the parent context if not found in this one.
Parameters
- qualifier: Qualifier
  The qualifier to check.
Returns null | Context
The context containing the dependency matching the given qualifier. Null if not found anywhere.
- Defined in Context.ts:240

get

get<T, P extends unknown[]>(
fn: (...params: P) => T,
): Promise<(...params: unknown[]) => T> | ((...params: unknown[]) => T)
Type Parameters
- T
- P extends unknown[]
Parameters
- fn: (...params: P) => T
Returns Promise<(...params: unknown[]) => T> | ((...params: unknown[]) => T)
- Defined in Context.ts:244
get<T>(qualifier: Qualifier<T>, params?: unknown[]): T | Promise<T>
Type Parameters
- T
Parameters
- qualifier: Qualifier<T>
- Optionalparams: unknown[]
Returns T | Promise<T>
- Defined in Context.ts:245

getAsync

getAsync<T, P extends unknown[]>(
fn: (...params: P) => T,
): Promise<(...params: unknown[]) => T>
Type Parameters
- T
- P extends unknown[]
Parameters
- fn: (...params: P) => T
Returns Promise<(...params: unknown[]) => T>
- Defined in Context.ts:261
getAsync<T>(qualifier: Qualifier<T>, params?: unknown[]): Promise<T>
Type Parameters
- T
Parameters
- qualifier: Qualifier<T>
- Optionalparams: unknown[]
Returns Promise<T>
- Defined in Context.ts:262

getParent

getParent(): null | Context
Returns null | Context
The parent context or null if this is a root context.
- Defined in Context.ts:82

getSync

getSync<T, P extends unknown[]>(
fn: (...params: P) => T,
): (...params: unknown[]) => T
Type Parameters
- T
- P extends unknown[]
Parameters
- fn: (...params: P) => T
Returns (...params: unknown[]) => T
- Defined in Context.ts:276
getSync<T>(qualifier: Qualifier<T>, params?: unknown[]): T
Type Parameters
- T
Parameters
- qualifier: Qualifier<T>
- Optionalparams: unknown[]
Returns T
- Defined in Context.ts:277

has

has(qualifier: Qualifier): boolean
Checks if this context (or its parents) have an injectable matching the given qualifier.
Parameters
- qualifier: Qualifier
  The dependency injection qualifier to look for.
Returns boolean
True if context or its parents have a matching injectable, false if not.
- Defined in Context.ts:218

isActive

isActive(): boolean
Checks if this dependency injection context is currently active.

Returns boolean
True if this dependency injection context is active, false if not.
- Defined in Context.ts:102

remove

remove(qualifier: Qualifier): boolean
Removes the injectable with the given qualifier from this dependency injection context. It is only removed from this context, the removal does not bubble up the parent hierarchy.
Parameters
- qualifier: Qualifier
  The qualifier to remove.
Returns boolean
True if an injectable was found and removed, false if not.
- Defined in Context.ts:229

setClass

setClass<T>(type: Constructor<T, []>, options?: InjectableOptions<[]>): this
Type Parameters
- T
Parameters
- type: Constructor<T, []>
- Optionaloptions: InjectableOptions<[]>
Returns this
- Defined in Context.ts:149
setClass<
    T,
    P extends unknown[],
    Q extends { [K in string | number | symbol]: Qualifier<P[K<K>]> },
>(
    type: Constructor<T, P>,
    options: InjectableOptions<Q> & { inject: Q },
): this
Type Parameters
- T
- P extends unknown[]
- Q extends { [K in string | number | symbol]: Qualifier<P[K<K>]> }
Parameters
- type: Constructor<T, P>
- options: InjectableOptions<Q> & { inject: Q }
Returns this
- Defined in Context.ts:150
setClass<
    T,
    P extends unknown[],
    Q extends { [K in string | number | symbol]: NullableQualifier<P[K<K>]> },
>(
    type: Constructor<T, P>,
    options: InjectableOptions<Q> & { inject: Q; scope: PROTOTYPE },
): this
Type Parameters
- T
- P extends unknown[]
- Q extends { [K in string | number | symbol]: NullableQualifier<P[K<K>]> }
Parameters
- type: Constructor<T, P>
- options: InjectableOptions<Q> & { inject: Q; scope: PROTOTYPE }
Returns this
- Defined in Context.ts:151

setFactory

setFactory<T>(
    type: Class<T>,
    factory: Factory<T, []>,
    options?: InjectableOptions<[]>,
): this
Type Parameters
- T
Parameters
- type: Class<T>
- factory: Factory<T, []>
- Optionaloptions: InjectableOptions<[]>
Returns this
- Defined in Context.ts:164
setFactory<T, P extends unknown[]>(
    type: Class<T>,
    factory: Factory<T, P>,
    options: InjectableOptions<
        NoInfer<{ [K in string | number | symbol]: Qualifier<P[K<K>]> }>,
    > & {
        inject: NoInfer<
            { [K in string
            | number
            | symbol]: Qualifier<P[K<K>]> },
        >;
    },
): this
Type Parameters
- T
- P extends unknown[]
Parameters
- type: Class<T>
- factory: Factory<T, P>
- options: InjectableOptions<
  NoInfer<{ [K in string | number | symbol]: Qualifier<P[K<K>]> }>,
  > & {
  inject: NoInfer<{ [K in string | number | symbol]: Qualifier<P[K<K>]> }>;
  }
Returns this
- Defined in Context.ts:165
setFactory<T, P extends unknown[]>(
    type: Class<T>,
    factory: Factory<T, P>,
    options: InjectableOptions<
        NoInfer<
            { [K in string
            | number
            | symbol]: NullableQualifier<P[K<K>]> },
        >,
    > & {
        inject: NoInfer<
            { [K in string
            | number
            | symbol]: NullableQualifier<P[K<K>]> },
        >;
        scope: PROTOTYPE;
    },
): this
Type Parameters
- T
- P extends unknown[]
Parameters
- type: Class<T>
- factory: Factory<T, P>
- options: InjectableOptions<
      NoInfer<{ [K in string | number | symbol]: NullableQualifier<P[K<K>]> }>,
  > & {
      inject: NoInfer<
          { [K in string
          | number
          | symbol]: NullableQualifier<P[K<K>]> },
      >;
      scope: PROTOTYPE;
  }
Returns this
- Defined in Context.ts:167

setFunction

setFunction<P extends unknown[]>(
    func: (...params: P) => unknown,
    inject: NoInfer<
        { [K in string
        | number
        | symbol]: NullableQualifier<P[K<K>]> },
    >,
    name?: string | symbol | (string | symbol)[],
): this
Registers the given injectable function in this dependency injection context. Using null in the inject array defines placeholders for pass-through function parameter. So when injecting a function with inject arguments [ null, Service, null ] the resolved function expects two parameters which are filled into the placeholders while Service is injected automatically.
Type Parameters
- P extends unknown[]
Parameters
- func: (...params: P) => unknown
  The value to inject.
- inject: NoInfer<{ [K in string | number | symbol]: NullableQualifier<P[K<K>]> }>
  The parameter types. Must match the function signature but allows specifying null as type for marking pass-through parameters.
- Optionalname: string | symbol | (string | symbol)[]
  Optional name (or names) under which to inject the function. If not set then function is only injected via its type.
Returns this
- Defined in Context.ts:201

setValue

setValue<T extends Object>(
value: T,
name?: string | symbol | (string | symbol)[],
): this
Registers the given injectable value in this dependency injection context.
Type Parameters
- T extends Object
Parameters
- value: T
  The value to inject.
- Optionalname: string | symbol | (string | symbol)[]
  Optional name (or names) under which to inject the value. If not set then value is only injected via its type.
Returns this
- Defined in Context.ts:188

`Static`getActive

getActive(): Context
Returns Context
The currently active dependency injection context.
- Defined in Context.ts:59

`Static`getRoot

getRoot(): Context
Returns Context
The root dependency injection context.
- Defined in Context.ts:66

Class Context

Index

Methods

Methods

activate

Returns Context

createChildContext

Returns Context

findContext

Parameters

Returns null | Context

get

Type Parameters

Parameters

Returns Promise<(...params: unknown[]) => T> | ((...params: unknown[]) => T)

Type Parameters

Parameters

Returns T | Promise<T>

getAsync

Type Parameters

Parameters

Returns Promise<(...params: unknown[]) => T>

Type Parameters

Parameters

Returns Promise<T>

getParent

Returns null | Context

getSync

Type Parameters

Parameters

Returns (...params: unknown[]) => T

Type Parameters

Parameters

Returns T

has

Parameters

Returns boolean

isActive

Returns boolean

remove

Parameters

Returns boolean

setClass

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

setFactory

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

setFunction

Type Parameters

Parameters

Returns this

setValue

Type Parameters

Parameters

Returns this

StaticgetActive

Returns Context

StaticgetRoot

Returns Context

Settings

On This Page

`Static`getActive

`Static`getRoot