cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(core): update API doc examples to use static injector (#29729)

Browse Source 
PR Close #29729
This commit is contained in:
Brandon
2019-04-05 16:33:26 +00:00
committed by Igor Minar
parent 632847d34d
commit 82c77ce232
3 changed files with 34 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
packages/core/src/di/injectable.ts
View File

@ -39,13 +39,8 @@ export interface InjectableDecorator {
*
* The following example shows how service classes are properly marked as
* injectable.
*
* {@example core/di/ts/metadata_spec.ts region='Injectable'}
*
* `Injector` throws an error if it tries to instantiate a class that
* is not decorated with `@Injectable`, as shown in the following example.
*
* {@example core/di/ts/metadata_spec.ts region='InjectableThrows'}
*Z
* <code-example path="core/di/ts/metadata_spec.ts" region="Injectable"></code-example>
*
*/
(): TypeDecorator;

14
packages/core/src/di/metadata.ts
View File

@ -26,12 +26,11 @@ export interface InjectDecorator {
* The following example shows a class constructor that specifies a
* custom provider of a dependency using the parameter decorator.
*
* {@example core/di/ts/metadata_spec.ts region='Inject'}
*
* When `@Inject()` is not present, the injector uses the type annotation of the
* parameter as the provider.
*
* {@example core/di/ts/metadata_spec.ts region='InjectWithoutDecorator'}
* <code-example path="core/di/ts/metadata_spec.ts"
* region="InjectWithoutDecorator"></code-example>
*/
(token: any): any;
new (token: any): Inject;
@ -78,7 +77,7 @@ export interface OptionalDecorator {
*
* The following code allows the possibility of a null result:
*
* {@example core/di/ts/metadata_spec.ts region='Optional'}
* <code-example path="core/di/ts/metadata_spec.ts" region="Optional"></code-example>
*
*/
(): any;
@ -119,7 +118,8 @@ export interface SelfDecorator {
* by the local injector when instantiating the class itself, but not
* when instantiating a child.
*
* {@example core/di/ts/metadata_spec.ts region='Self'}
* <code-example path="core/di/ts/metadata_spec.ts" region="Self"></code-example>
*
*
* @see `SkipSelf`
* @see `Optional`
@ -162,7 +162,7 @@ export interface SkipSelfDecorator {
* In the following example, the dependency can be resolved when
* instantiating a child, but not when instantiating the class itself.
*
* {@example core/di/ts/metadata_spec.ts region='SkipSelf'}
* <code-example path="core/di/ts/metadata_spec.ts" region="SkipSelf"></code-example>
*
* Learn more in the
* [Dependency Injection guide](guide/dependency-injection-in-action#skip).
@ -208,7 +208,7 @@ export interface HostDecorator {
*
* The following shows use with the `@Optional` decorator, and allows for a null result.
*
* {@example core/di/ts/metadata_spec.ts region='Host'}
* <code-example path="core/di/ts/metadata_spec.ts" region="Host"></code-example>
*/
(): any;
new (): Host;