d169c2434e
- Introduce `InjectionToken<T>` which is a parameterized and type-safe
version of `OpaqueToken`.
DEPRECATION:
- `OpaqueToken` is now deprecated, use `InjectionToken<T>` instead.
- `Injector.get(token: any, notFoundValue?: any): any` is now deprecated
use the same method which is now overloaded as
`Injector.get<T>(token: Type<T>|InjectionToken<T>, notFoundValue?: T): T;`.
Migration
- Replace `OpaqueToken` with `InjectionToken<?>` and parameterize it.
- Migrate your code to only use `Type<?>` or `InjectionToken<?>` as
injection tokens. Using other tokens will not be supported in the
future.
BREAKING CHANGE:
- Because `injector.get()` is now parameterize it is possible that code
which used to work no longer type checks. Example would be if one
injects `Foo` but configures it as `{provide: Foo, useClass: MockFoo}`.
The injection instance will be that of `MockFoo` but the type will be
`Foo` instead of `any` as in the past. This means that it was possible
to call a method on `MockFoo` in the past which now will fail type
check. See this example:
```
class Foo {}
class MockFoo extends Foo {
setupMock();
}
var PROVIDERS = [
{provide: Foo, useClass: MockFoo}
];
...
function myTest(injector: Injector) {
var foo = injector.get(Foo);
// This line used to work since `foo` used to be `any` before this
// change, it will now be `Foo`, and `Foo` does not have `setUpMock()`.
// The fix is to downcast: `injector.get(Foo) as MockFoo`.
foo.setUpMock();
}
```
PR Close #13785
221 lines
5.8 KiB
TypeScript
221 lines
5.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {Type} from '../type';
|
|
|
|
/**
|
|
* @whatItDoes Configures the {@link Injector} to return an instance of `Type` when `Type' is used
|
|
* as token.
|
|
* @howToUse
|
|
* ```
|
|
* @Injectable()
|
|
* class MyService {}
|
|
*
|
|
* const provider: TypeProvider = MyService;
|
|
* ```
|
|
*
|
|
* @description
|
|
*
|
|
* Create an instance by invoking the `new` operator and supplying additional arguments.
|
|
* This form is a short form of `TypeProvider`;
|
|
*
|
|
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
|
|
*
|
|
* ### Example
|
|
*
|
|
* {@example core/di/ts/provider_spec.ts region='TypeProvider'}
|
|
*
|
|
* @stable
|
|
*/
|
|
export interface TypeProvider extends Type<any> {}
|
|
|
|
/**
|
|
* @whatItDoes Configures the {@link Injector} to return a value for a token.
|
|
* @howToUse
|
|
* ```
|
|
* const provider: ValueProvider = {provide: 'someToken', useValue: 'someValue'};
|
|
* ```
|
|
*
|
|
* @description
|
|
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
|
|
*
|
|
* ### Example
|
|
*
|
|
* {@example core/di/ts/provider_spec.ts region='ValueProvider'}
|
|
*
|
|
* @stable
|
|
*/
|
|
export interface ValueProvider {
|
|
/**
|
|
* An injection token. (Typically an instance of `Type` or `InjectionToken`, but can be `any`).
|
|
*/
|
|
provide: any;
|
|
|
|
/**
|
|
* The value to inject.
|
|
*/
|
|
useValue: any;
|
|
|
|
/**
|
|
* If true, than injector returns an array of instances. This is useful to allow multiple
|
|
* providers spread across many files to provide configuration information to a common token.
|
|
*
|
|
* ### Example
|
|
*
|
|
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
|
*/
|
|
multi?: boolean;
|
|
}
|
|
|
|
/**
|
|
* @whatItDoes Configures the {@link Injector} to return an instance of `useClass` for a token.
|
|
* @howToUse
|
|
* ```
|
|
* @Injectable()
|
|
* class MyService {}
|
|
*
|
|
* const provider: ClassProvider = {provide: 'someToken', useClass: MyService};
|
|
* ```
|
|
*
|
|
* @description
|
|
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
|
|
*
|
|
* ### Example
|
|
*
|
|
* {@example core/di/ts/provider_spec.ts region='ClassProvider'}
|
|
*
|
|
* Note that following two providers are not equal:
|
|
* {@example core/di/ts/provider_spec.ts region='ClassProviderDifference'}
|
|
*
|
|
* @stable
|
|
*/
|
|
export interface ClassProvider {
|
|
/**
|
|
* An injection token. (Typically an instance of `Type` or `InjectionToken`, but can be `any`).
|
|
*/
|
|
provide: any;
|
|
|
|
/**
|
|
* Class to instantiate for the `token`.
|
|
*/
|
|
useClass: Type<any>;
|
|
|
|
/**
|
|
* If true, than injector returns an array of instances. This is useful to allow multiple
|
|
* providers spread across many files to provide configuration information to a common token.
|
|
*
|
|
* ### Example
|
|
*
|
|
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
|
*/
|
|
multi?: boolean;
|
|
}
|
|
|
|
/**
|
|
* @whatItDoes Configures the {@link Injector} to return a value of another `useExisting` token.
|
|
* @howToUse
|
|
* ```
|
|
* const provider: ExistingProvider = {provide: 'someToken', useExisting: 'someOtherToken'};
|
|
* ```
|
|
*
|
|
* @description
|
|
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
|
|
*
|
|
* ### Example
|
|
*
|
|
* {@example core/di/ts/provider_spec.ts region='ExistingProvider'}
|
|
*
|
|
* @stable
|
|
*/
|
|
export interface ExistingProvider {
|
|
/**
|
|
* An injection token. (Typically an instance of `Type` or `InjectionToken`, but can be `any`).
|
|
*/
|
|
provide: any;
|
|
|
|
/**
|
|
* Existing `token` to return. (equivalent to `injector.get(useExisting)`)
|
|
*/
|
|
useExisting: any;
|
|
|
|
/**
|
|
* If true, than injector returns an array of instances. This is useful to allow multiple
|
|
* providers spread across many files to provide configuration information to a common token.
|
|
*
|
|
* ### Example
|
|
*
|
|
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
|
*/
|
|
multi?: boolean;
|
|
}
|
|
|
|
/**
|
|
* @whatItDoes Configures the {@link Injector} to return a value by invoking a `useFactory`
|
|
* function.
|
|
* @howToUse
|
|
* ```
|
|
* function serviceFactory() { ... }
|
|
*
|
|
* const provider: FactoryProvider = {provide: 'someToken', useFactory: serviceFactory, deps: []};
|
|
* ```
|
|
*
|
|
* @description
|
|
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
|
|
*
|
|
* ### Example
|
|
*
|
|
* {@example core/di/ts/provider_spec.ts region='FactoryProvider'}
|
|
*
|
|
* Dependencies can also be marked as optional:
|
|
* {@example core/di/ts/provider_spec.ts region='FactoryProviderOptionalDeps'}
|
|
*
|
|
* @stable
|
|
*/
|
|
export interface FactoryProvider {
|
|
/**
|
|
* An injection token. (Typically an instance of `Type` or `InjectionToken`, but can be `any`).
|
|
*/
|
|
provide: any;
|
|
|
|
/**
|
|
* A function to invoke to create a value for this `token`. The function is invoked with
|
|
* resolved values of `token`s in the `deps` field.
|
|
*/
|
|
useFactory: Function;
|
|
|
|
/**
|
|
* A list of `token`s which need to be resolved by the injector. The list of values is than
|
|
* used as arguments to the `useFactory` function.
|
|
*/
|
|
deps?: any[];
|
|
|
|
/**
|
|
* If true, than injector returns an array of instances. This is useful to allow multiple
|
|
* providers spread across many files to provide configuration information to a common token.
|
|
*
|
|
* ### Example
|
|
*
|
|
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
|
*/
|
|
multi?: boolean;
|
|
}
|
|
|
|
/**
|
|
* @whatItDoes Describes how the {@link Injector} should be configured.
|
|
* @howToUse
|
|
* See {@link TypeProvider}, {@link ValueProvider}, {@link ClassProvider}, {@link ExistingProvider},
|
|
* {@link FactoryProvider}.
|
|
*
|
|
* @description
|
|
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
|
|
*
|
|
* @stable
|
|
*/
|
|
export type Provider =
|
|
TypeProvider | ValueProvider | ClassProvider | ExistingProvider | FactoryProvider | any[];
|