From a9502886b179ee59b36bc222e5ad602592e2f637 Mon Sep 17 00:00:00 2001 From: Judy Bogart Date: Mon, 10 Jun 2019 10:04:11 -0700 Subject: [PATCH] docs: mark interfaces as public (#30955) PR Close #30955 --- packages/core/src/di/index.ts | 2 +- packages/core/src/di/interface/provider.ts | 37 +++++++++++----------- tools/public_api_guard/core/core.d.ts | 8 +++++ 3 files changed, 27 insertions(+), 20 deletions(-) diff --git a/packages/core/src/di/index.ts b/packages/core/src/di/index.ts index 6435213cad..929e8d3072 100644 --- a/packages/core/src/di/index.ts +++ b/packages/core/src/di/index.ts @@ -20,7 +20,7 @@ export {Injectable, InjectableDecorator, InjectableProvider} from './injectable' export {Injector} from './injector'; export {ɵɵinject, inject, INJECTOR} from './injector_compatibility'; export {ReflectiveInjector} from './reflective_injector'; -export {StaticProvider, ValueProvider, ConstructorSansProvider, ExistingProvider, FactoryProvider, Provider, TypeProvider, ClassProvider} from './interface/provider'; +export {StaticProvider, ValueProvider, ConstructorSansProvider, ExistingProvider, FactoryProvider, Provider, TypeProvider, ClassProvider, ValueSansProvider, ClassSansProvider} from './interface/provider'; export {ResolvedReflectiveFactory, ResolvedReflectiveProvider} from './reflective_provider'; export {ReflectiveKey} from './reflective_key'; export {InjectionToken} from './injection_token'; diff --git a/packages/core/src/di/interface/provider.ts b/packages/core/src/di/interface/provider.ts index e45a8c55db..ead558ee8a 100644 --- a/packages/core/src/di/interface/provider.ts +++ b/packages/core/src/di/interface/provider.ts @@ -10,13 +10,7 @@ import {Type} from '../../interface/type'; /** * Configures the `Injector` to return a value for a token. - * - * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). - * - * @usageNotes - * ### Example - * - * {@example core/di/ts/provider_spec.ts region='ValueSansProvider'} + * Base for `ValueProvider` decorator. * * @publicApi */ @@ -33,6 +27,7 @@ export interface ValueSansProvider { * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * * @usageNotes + * * ### Example * * {@example core/di/ts/provider_spec.ts region='ValueProvider'} @@ -58,13 +53,7 @@ export interface ValueProvider extends ValueSansProvider { /** * Configures the `Injector` to return an instance of `useClass` for a token. - * - * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). - * - * @usageNotes - * ### Example - * - * {@example core/di/ts/provider_spec.ts region='StaticClassSansProvider'} + * Base for `StaticClassProvider` decorator. * * @publicApi */ @@ -88,6 +77,7 @@ export interface StaticClassSansProvider { * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * * @usageNotes + * * ### Example * * {@example core/di/ts/provider_spec.ts region='StaticClassProvider'} @@ -99,6 +89,8 @@ export interface StaticClassSansProvider { * ### Multi-value example * * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'} + * + * @publicApi */ export interface StaticClassProvider extends StaticClassSansProvider { /** @@ -119,6 +111,7 @@ export interface StaticClassProvider extends StaticClassSansProvider { * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * * @usageNotes + * * ### Example * * ``` @@ -142,6 +135,7 @@ export interface ConstructorSansProvider { * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * * @usageNotes + * * ### Example * * {@example core/di/ts/provider_spec.ts region='ConstructorProvider'} @@ -149,6 +143,8 @@ export interface ConstructorSansProvider { * ### Multi-value example * * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'} + * + * @publicApi */ export interface ConstructorProvider extends ConstructorSansProvider { /** @@ -169,9 +165,12 @@ export interface ConstructorProvider extends ConstructorSansProvider { * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * * @usageNotes + * * ### Example * * {@example core/di/ts/provider_spec.ts region='ExistingSansProvider'} + * + * @publicApi */ export interface ExistingSansProvider { /** @@ -186,6 +185,7 @@ export interface ExistingSansProvider { * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * * @usageNotes + * * ### Example * * {@example core/di/ts/provider_spec.ts region='ExistingProvider'} @@ -241,6 +241,7 @@ export interface FactorySansProvider { * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * * @usageNotes + * * ### Example * * {@example core/di/ts/provider_spec.ts region='FactoryProvider'} @@ -292,6 +293,7 @@ export type StaticProvider = ValueProvider | ExistingProvider | StaticClassProvi * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * * @usageNotes + * * ### Example * * {@example core/di/ts/provider_spec.ts region='TypeProvider'} @@ -302,14 +304,10 @@ export interface TypeProvider extends Type {} /** * Configures the `Injector` to return a value by invoking a `useClass` function. + * Base for `ClassProvider` decorator. * * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * - * @usageNotes - * ### Example - * - * {@example core/di/ts/provider_spec.ts region='ClassSansProvider'} - * * @publicApi */ export interface ClassSansProvider { @@ -325,6 +323,7 @@ export interface ClassSansProvider { * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * * @usageNotes + * * ### Example * * {@example core/di/ts/provider_spec.ts region='ClassProvider'} diff --git a/tools/public_api_guard/core/core.d.ts b/tools/public_api_guard/core/core.d.ts index 5927fb84c9..2d906545a4 100644 --- a/tools/public_api_guard/core/core.d.ts +++ b/tools/public_api_guard/core/core.d.ts @@ -80,6 +80,10 @@ export interface ClassProvider extends ClassSansProvider { provide: any; } +export interface ClassSansProvider { + useClass: Type; +} + /** @deprecated */ export interface CollectionChangeRecord extends IterableChangeRecord { } @@ -1386,6 +1390,10 @@ export interface ValueProvider extends ValueSansProvider { provide: any; } +export interface ValueSansProvider { + useValue: any; +} + export declare class Version { full: string; readonly major: string;