W3cubDocs

/Angular

Optional

decorator

Parameter decorator to be used on constructor parameters, which marks the parameter as being an optional dependency. The DI framework provides null if the dependency is not found.

See more...

See also

Description

Can be used together with other parameter decorators that modify how dependency injection operates.

Further information is available in the Usage Notes...

Options

Usage notes

The following code allows the possibility of a null result:

class Engine {}

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

const injector =
    Injector.create({providers: [{provide: Car, deps: [[new Optional(), Engine]]}]});
expect(injector.get(Car).engine).toBeNull();

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