What it does
Configures the Injector
to return a value by invoking a useFactory
function.
How to use
function serviceFactory() { ... }
const provider: FactoryProvider = {provide: 'someToken', useFactory: serviceFactory, deps: []};
Interface Overview
interface FactoryProvider {
}
Interface Description
For more details, see the Dependency Injection Guide.
Example
const Location = new InjectionToken('location');
const Hash = new InjectionToken('hash');
const injector = ReflectiveInjector.resolveAndCreate([
{provide: Location, useValue: 'http://angular.io/#someLocation'}, {
provide: Hash,
useFactory: (location: string) => location.split('#')[1],
deps: [Location]
}
]);
expect(injector.get(Hash)).toEqual('someLocation');
Dependencies can also be marked as optional:
const Location = new InjectionToken('location');
const Hash = new InjectionToken('hash');
const injector = ReflectiveInjector.resolveAndCreate([{
provide: Hash,
useFactory: (location: string) => `Hash for: ${location}`,
// use a nested array to define metadata for dependencies.
deps: [[new Optional(), Location]]
}]);
expect(injector.get(Hash)).toEqual('Hash for: null');
Interface Details
provide : any
An injection token. (Typically an instance of Type
or InjectionToken
, but can be any
).
useFactory : Function
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.
deps : any[]
A list of token
s which need to be resolved by the injector. The list of values is then
used as arguments to the useFactory
function.
multi : boolean
If true, then 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.
const injector = ReflectiveInjector.resolveAndCreate([
{provide: 'local', multi: true, useValue: 'en'},
{provide: 'local', multi: true, useValue: 'sk'},
]);
const locales: string[] = injector.get('local');
expect(locales).toEqual(['en', 'sk']);
exported from core/index,
defined in core/src/di/provider.ts