W3cubDocs

/Angular

EnvironmentInjector

class

An Injector that's part of the environment injector hierarchy, which exists outside of the component tree.

abstract class EnvironmentInjector implements Injector {
  abstract get<T>(token: ProviderToken<T>, notFoundValue: undefined, options: InjectOptions & { optional?: false; }): T
  abstract runInContext<ReturnT>(fn: () => ReturnT): ReturnT
  abstract destroy(): void
}

Methods

get()

Retrieves an instance from the injector based on the provided token.

4 overloads...

Show All Hide All

`abstract get<T>(token: ProviderToken<T>, notFoundValue: undefined, options: InjectOptions & { optional?: false; }): T`

Parameters

`token`	`ProviderToken<T>`
`notFoundValue`	`undefined`
`options`	`InjectOptions & { optional?: false; }`

Returns

T: The instance from the injector if defined, otherwise the notFoundValue.

Throws

Error When the notFoundValue is undefined or Injector.THROW_IF_NOT_FOUND.

Overload #1

`abstract get<T>(token: ProviderToken<T>, notFoundValue: null, options: InjectOptions): T | null`

Parameters

`token`	`ProviderToken<T>`
`notFoundValue`	`null`
`options`	`InjectOptions`

Returns

T | null: The instance from the injector if defined, otherwise the notFoundValue.

Throws

Error When the notFoundValue is undefined or Injector.THROW_IF_NOT_FOUND.

Overload #2

`abstract get<T>(token: ProviderToken<T>, notFoundValue?: T, options?: InjectOptions): T`

Parameters

`token`	`ProviderToken<T>`
`notFoundValue`	`T`	Optional. Default is `undefined`.
`options`	`InjectOptions`	Optional. Default is `undefined`.

Returns

T: The instance from the injector if defined, otherwise the notFoundValue.

Throws

Error When the notFoundValue is undefined or Injector.THROW_IF_NOT_FOUND.

Overload #3

`abstract get<T>(token: ProviderToken<T>, notFoundValue?: T, flags?: InjectFlags): T`

Deprecated use object-based flags (InjectOptions) instead.

Parameters

`token`	`ProviderToken<T>`
`notFoundValue`	`T`	Optional. Default is `undefined`.
`flags`	`InjectFlags`	Optional. Default is `undefined`.

Returns

T: The instance from the injector if defined, otherwise the notFoundValue.

Throws

Error When the notFoundValue is undefined or Injector.THROW_IF_NOT_FOUND.

Overload #4

`abstract get(token: any, notFoundValue?: any): any`

Deprecated from v4.0.0 use ProviderToken

Parameters

`token`	`any`
`notFoundValue`	`any`	Optional. Default is `undefined`.

Returns

any

runInContext() Deprecated

Runs the given function in the context of this EnvironmentInjector.

`abstract runInContext<ReturnT>(fn: () => ReturnT): ReturnT`

Deprecated use the standalone function runInInjectionContext instead

Parameters

fn

() => ReturnT

the closure to be run in the context of this injector

Returns

ReturnT: the return value of the function, if any

Within the function's stack frame, inject can be used to inject dependencies from this injector. Note that inject is only usable synchronously, and cannot be used in any asynchronous callbacks or after any await points.

destroy()
`abstract destroy(): void` Parameters There are no parameters. Returns `void`

© 2010–2023 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/api/core/EnvironmentInjector