docs: convert all @experimental tags to @publicApi tags (#26595)

PR Close #26595
This commit is contained in:
Pete Bacon Darwin
2018-10-19 12:12:20 +01:00
committed by Alex Rickabaugh
parent 4bd9f53e8f
commit 24521f549c
116 changed files with 331 additions and 331 deletions

View File

@ -72,7 +72,7 @@ export interface InjectorDef<T> {
* `InjectableDefType`s contain their own Dependency Injection metadata and are usable in an
* `InjectorDef`-based `StaticInjector.
*
* @experimental
* @publicApi
*/
export interface InjectableType<T> extends Type<T> {
/**
@ -86,7 +86,7 @@ export interface InjectableType<T> extends Type<T> {
*
* `InjectorDefTypes` can be used to configure a `StaticInjector`.
*
* @experimental
* @publicApi
*/
export interface InjectorType<T> extends Type<T> {
/**
@ -124,7 +124,7 @@ export interface InjectorTypeWithProviders<T> {
* * `factory` gives the zero argument function which will create an instance of the injectable.
* The factory can call `inject` to access the `Injector` and request injection of dependencies.
*
* @experimental
* @publicApi
*/
export function defineInjectable<T>(opts: {
providedIn?: Type<any>| 'root' | 'any' | null,
@ -153,7 +153,7 @@ export function defineInjectable<T>(opts: {
* whose providers will also be added to the injector. Locally provided types will override
* providers from imports.
*
* @experimental
* @publicApi
*/
export function defineInjector(options: {factory: () => any, providers?: any[], imports?: any[]}):
never {

View File

@ -18,7 +18,7 @@ import {stringify} from '../util';
* ### Example
*
* {@example core/di/ts/forward_ref/forward_ref_spec.ts region='forward_ref_fn'}
* @experimental
* @publicApi
*/
export interface ForwardRefFn { (): any; }
@ -32,7 +32,7 @@ export interface ForwardRefFn { (): any; }
* @usageNotes
* ### Example
* {@example core/di/ts/forward_ref/forward_ref_spec.ts region='forward_ref'}
* @experimental
* @publicApi
*/
export function forwardRef(forwardRefFn: ForwardRefFn): Type<any> {
(<any>forwardRefFn).__forward_ref__ = forwardRef;
@ -51,7 +51,7 @@ export function forwardRef(forwardRefFn: ForwardRefFn): Type<any> {
* {@example core/di/ts/forward_ref/forward_ref_spec.ts region='resolve_forward_ref'}
*
* @see `forwardRef`
* @experimental
* @publicApi
*/
export function resolveForwardRef(type: any): any {
if (typeof type === 'function' && type.hasOwnProperty('__forward_ref__') &&

View File

@ -18,7 +18,7 @@ import {convertInjectableProviderToFactory} from './util';
/**
* Injectable providers used in `@Injectable` decorator.
*
* @experimental
* @publicApi
*/
export type InjectableProvider = ValueSansProvider | ExistingSansProvider |
StaticClassSansProvider | ConstructorSansProvider | FactorySansProvider | ClassSansProvider;
@ -52,7 +52,7 @@ export interface InjectableDecorator {
/**
* Type of the Injectable metadata.
*
* @experimental
* @publicApi
*/
export interface Injectable { providedIn?: Type<any>|'root'|null; }
@ -68,7 +68,7 @@ export const Injectable: InjectableDecorator = makeDecorator(
/**
* Type representing injectable service.
*
* @experimental
* @publicApi
*/
export interface InjectableType<T> extends Type<T> { ngInjectableDef: InjectableDef<T>; }

View File

@ -26,7 +26,7 @@ export const THROW_IF_NOT_FOUND = _THROW_IF_NOT_FOUND;
* Requesting this token instead of `Injector` allows `StaticInjector` to be tree-shaken from a
* project.
*
* @experimental
* @publicApi
*/
export const INJECTOR = new InjectionToken<Injector>('INJECTOR');
@ -445,7 +445,7 @@ export function setCurrentInjector(injector: Injector | null | undefined): Injec
* of providing an additional array of dependencies as was common to do with `useFactory` providers.
* `inject` is faster and more type-safe.
*
* @experimental
* @publicApi
*/
export function inject<T>(token: Type<T>| InjectionToken<T>): T;
export function inject<T>(token: Type<T>| InjectionToken<T>, flags?: InjectFlags): T|null;

View File

@ -18,7 +18,7 @@ import {Type} from '../type';
*
* {@example core/di/ts/provider_spec.ts region='ValueSansProvider'}
*
* @experimental
* @publicApi
*/
export interface ValueSansProvider {
/**
@ -64,7 +64,7 @@ export interface ValueProvider extends ValueSansProvider {
*
* {@example core/di/ts/provider_spec.ts region='StaticClassSansProvider'}
*
* @experimental
* @publicApi
*/
export interface StaticClassSansProvider {
/**
@ -124,7 +124,7 @@ export interface StaticClassProvider extends StaticClassSansProvider {
* class MyService {}
* ```
*
* @experimental
* @publicApi
*/
export interface ConstructorSansProvider {
/**
@ -215,7 +215,7 @@ export interface ExistingProvider extends ExistingSansProvider {
*
* {@example core/di/ts/provider_spec.ts region='FactorySansProvider'}
*
* @experimental
* @publicApi
*/
export interface FactorySansProvider {
/**
@ -300,7 +300,7 @@ export interface TypeProvider extends Type<any> {}
*
* {@example core/di/ts/provider_spec.ts region='ClassSansProvider'}
*
* @experimental
* @publicApi
*/
export interface ClassSansProvider {
/**

View File

@ -66,7 +66,7 @@ interface Record<T> {
/**
* Create a new `Injector` which is configured using a `defType` of `InjectorType<any>`s.
*
* @experimental
* @publicApi
*/
export function createInjector(
defType: /* InjectorType<any> */ any, parent: Injector | null = null,

View File

@ -140,7 +140,7 @@ export abstract class ReflectiveInjector implements Injector {
* var injector = ReflectiveInjector.fromResolvedProviders(providers);
* expect(injector.get(Car) instanceof Car).toBe(true);
* ```
* @experimental
* @publicApi
*/
static fromResolvedProviders(providers: ResolvedReflectiveProvider[], parent?: Injector):
ReflectiveInjector {

View File

@ -52,7 +52,7 @@ const _EMPTY_LIST: any[] = [];
* expect(injector.get('message')).toEqual('Hello');
* ```
*
* @experimental
* @publicApi
*/
export interface ResolvedReflectiveProvider {
/**
@ -83,7 +83,7 @@ export class ResolvedReflectiveProvider_ implements ResolvedReflectiveProvider {
/**
* An internal resolved representation of a factory function created by resolving `Provider`.
* @experimental
* @publicApi
*/
export class ResolvedReflectiveFactory {
constructor(