W3cubDocs

/Angular 2 TypeScript

Optional decorator

What it does

A parameter metadata that marks a dependency as optional. Injector provides null if the dependency is not found.

How to use

@Injectable() class Car { constructor(@Optional() public engine:Engine) {} }

Description

For more details, see the Dependency Injection Guide.

Example

class Engine {}

@Injectable()
class Car {
  constructor(@Optional() public engine: Engine) {}
}

const injector = ReflectiveInjector.resolveAndCreate([Car]);
expect(injector.get(Car).engine).toBeNull();

exported from @angular/core/index defined in @angular/core/src/di/metadata.ts

© 2010–2017 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v2.angular.io/docs/ts/latest/api/core/index/Optional-decorator.html