Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FactoryProvider

whatitdoes

Configures the 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

Hierarchy

Index

Properties

Optional deps

deps: any[]

A list of tokens which need to be resolved by the injector. The list of values is then used as arguments to the useFactory function.

Optional multi

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.

Example

{@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}

provide

provide: any

An injection token. (Typically an instance of Type or InjectionToken, but can be any).

useFactory

useFactory: Function

A function to invoke to create a value for this token. The function is invoked with resolved values of tokens in the deps field.

Generated using TypeDoc