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

docs: remove all deprecated @stable jsdoc tags (#23210)

Browse Source 
These are no longer needed as stable docs are computed as those that
do not have `@experimental` or `@deprecated` tags.

PR Close #23210
This commit is contained in:
Pete Bacon Darwin
2018-04-05 22:31:44 +01:00
committed by Igor Minar
parent ee145790d7
commit 4b96a58c5a
155 changed files with 363 additions and 643 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
tools/public_api_guard/common/common.d.ts vendored
View File

@ -1,7 +1,5 @@
/** @stable */
export declare const APP_BASE_HREF: InjectionToken<string>;
/** @stable */
export declare class AsyncPipe implements OnDestroy, PipeTransform {
constructor(_ref: ChangeDetectorRef);
ngOnDestroy(): void;
@ -11,41 +9,34 @@ export declare class AsyncPipe implements OnDestroy, PipeTransform {
transform<T>(obj: null): null;
}
/** @stable */
export declare class CommonModule {
}
/** @stable */
export declare class CurrencyPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, currencyCode?: string, display?: 'code' | 'symbol' | 'symbol-narrow' | string | boolean, digitsInfo?: string, locale?: string): string | null;
}
/** @stable */
export declare class DatePipe implements PipeTransform {
constructor(locale: string);
transform(value: any, format?: string, timezone?: string, locale?: string): string | null;
}
/** @stable */
export declare class DecimalPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, digitsInfo?: string, locale?: string): string | null;
}
/** @stable */
export declare class DeprecatedCurrencyPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, currencyCode?: string, symbolDisplay?: boolean, digits?: string): string | null;
}
/** @stable */
export declare class DeprecatedDatePipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, pattern?: string): string | null;
}
/** @stable */
export declare class DeprecatedDecimalPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, digits?: string): string | null;
@ -55,25 +46,19 @@ export declare class DeprecatedDecimalPipe implements PipeTransform {
export declare class DeprecatedI18NPipesModule {
}
/** @stable */
export declare class DeprecatedPercentPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, digits?: string): string | null;
}
/** @stable */
export declare const DOCUMENT: InjectionToken<Document>;
/** @stable */
export declare function formatCurrency(value: number, locale: string, currency: string, currencyCode?: string, digitsInfo?: string): string;
/** @stable */
export declare function formatDate(value: string | number | Date, format: string, locale: string, timezone?: string): string;
/** @stable */
export declare function formatNumber(value: number, locale: string, digitsInfo?: string): string;
/** @stable */
export declare function formatPercent(value: number, locale: string, digitsInfo?: string): string;
/** @experimental */
@ -147,7 +132,6 @@ export declare function getLocaleWeekEndRange(locale: string): [WeekDay, WeekDay
/** @experimental */
export declare function getNumberOfCurrencyDigits(code: string): number;
/** @stable */
export declare class HashLocationStrategy extends LocationStrategy {
constructor(_platformLocation: PlatformLocation, _baseHref?: string);
back(): void;
@ -187,12 +171,10 @@ export declare function isPlatformWorkerApp(platformId: Object): boolean;
/** @experimental */
export declare function isPlatformWorkerUi(platformId: Object): boolean;
/** @stable */
export declare class JsonPipe implements PipeTransform {
transform(value: any): string;
}
/** @stable */
export declare class Location {
constructor(platformStrategy: LocationStrategy);
back(): void;
@ -223,7 +205,6 @@ export interface LocationChangeListener {
(e: LocationChangeEvent): any;
}
/** @stable */
export declare abstract class LocationStrategy {
abstract back(): void;
abstract forward(): void;
@ -235,12 +216,10 @@ export declare abstract class LocationStrategy {
abstract replaceState(state: any, title: string, url: string, queryParams: string): void;
}
/** @stable */
export declare class LowerCasePipe implements PipeTransform {
transform(value: string): string;
}
/** @stable */
export declare class NgClass implements DoCheck {
klass: string;
ngClass: string | string[] | Set<string> | {
@ -261,7 +240,6 @@ export declare class NgComponentOutlet implements OnChanges, OnDestroy {
ngOnDestroy(): void;
}
/** @stable */
export declare class NgForOf<T> implements DoCheck, OnChanges {
ngForOf: NgIterable<T>;
ngForTemplate: TemplateRef<NgForOfContext<T>>;
@ -271,7 +249,6 @@ export declare class NgForOf<T> implements DoCheck, OnChanges {
ngOnChanges(changes: SimpleChanges): void;
}
/** @stable */
export declare class NgForOfContext<T> {
$implicit: T;
count: number;
@ -284,7 +261,6 @@ export declare class NgForOfContext<T> {
constructor($implicit: T, ngForOf: NgIterable<T>, index: number, count: number);
}
/** @stable */
export declare class NgIf {
ngIf: any;
ngIfElse: TemplateRef<NgIfContext> | null;
@ -292,7 +268,6 @@ export declare class NgIf {
constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<NgIfContext>);
}
/** @stable */
export declare class NgIfContext {
$implicit: any;
ngIf: any;
@ -325,7 +300,6 @@ export declare class NgPluralCase {
constructor(value: string, template: TemplateRef<Object>, viewContainer: ViewContainerRef, ngPlural: NgPlural);
}
/** @stable */
export declare class NgStyle implements DoCheck {
ngStyle: {
[key: string]: string;
@ -334,24 +308,20 @@ export declare class NgStyle implements DoCheck {
ngDoCheck(): void;
}
/** @stable */
export declare class NgSwitch {
ngSwitch: any;
}
/** @stable */
export declare class NgSwitchCase implements DoCheck {
ngSwitchCase: any;
constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef<Object>, ngSwitch: NgSwitch);
ngDoCheck(): void;
}
/** @stable */
export declare class NgSwitchDefault {
constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef<Object>, ngSwitch: NgSwitch);
}
/** @stable */
export declare class NgTemplateOutlet implements OnChanges {
ngTemplateOutlet: TemplateRef<any>;
ngTemplateOutletContext: Object;
@ -385,7 +355,6 @@ export declare enum NumberSymbol {
CurrencyGroup = 13,
}
/** @stable */
export declare class PathLocationStrategy extends LocationStrategy {
constructor(_platformLocation: PlatformLocation, href?: string);
back(): void;
@ -398,13 +367,11 @@ export declare class PathLocationStrategy extends LocationStrategy {
replaceState(state: any, title: string, url: string, queryParams: string): void;
}
/** @stable */
export declare class PercentPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, digitsInfo?: string, locale?: string): string | null;
}
/** @stable */
export declare abstract class PlatformLocation {
readonly abstract hash: string;
readonly abstract pathname: string;
@ -439,7 +406,6 @@ export interface PopStateEvent {
/** @experimental */
export declare function registerLocaleData(data: any, localeId?: string | any, extraData?: any): void;
/** @stable */
export declare class SlicePipe implements PipeTransform {
transform(value: any, start: number, end?: number): any;
}
@ -450,7 +416,6 @@ export declare type Time = {
minutes: number;
};
/** @stable */
export declare class TitleCasePipe implements PipeTransform {
transform(value: string): string;
}
@ -463,12 +428,10 @@ export declare enum TranslationWidth {
Short = 3,
}
/** @stable */
export declare class UpperCasePipe implements PipeTransform {
transform(value: string): string;
}
/** @stable */
export declare const VERSION: Version;
/** @experimental */

28
tools/public_api_guard/common/http.d.ts vendored
View File

@ -1,12 +1,9 @@
/** @stable */
export declare const HTTP_INTERCEPTORS: InjectionToken<HttpInterceptor[]>;
/** @stable */
export declare abstract class HttpBackend implements HttpHandler {
abstract handle(req: HttpRequest<any>): Observable<HttpEvent<any>>;
}
/** @stable */
export declare class HttpClient {
constructor(handler: HttpHandler);
delete<T>(url: string, options?: {
@ -1478,15 +1475,12 @@ export declare class HttpClient {
}): Observable<any>;
}
/** @stable */
export declare class HttpClientJsonpModule {
}
/** @stable */
export declare class HttpClientModule {
}
/** @stable */
export declare class HttpClientXsrfModule {
static disable(): ModuleWithProviders;
static withOptions(options?: {
@ -1495,13 +1489,11 @@ export declare class HttpClientXsrfModule {
}): ModuleWithProviders;
}
/** @stable */
export interface HttpDownloadProgressEvent extends HttpProgressEvent {
partialText?: string;
type: HttpEventType.DownloadProgress;
}
/** @stable */
export declare class HttpErrorResponse extends HttpResponseBase implements Error {
readonly error: any | null;
readonly message: string;
@ -1516,10 +1508,8 @@ export declare class HttpErrorResponse extends HttpResponseBase implements Error
});
}
/** @stable */
export declare type HttpEvent<T> = HttpSentEvent | HttpHeaderResponse | HttpResponse<T> | HttpProgressEvent | HttpUserEvent<T>;
/** @stable */
export declare enum HttpEventType {
Sent = 0,
UploadProgress = 1,
@ -1529,12 +1519,10 @@ export declare enum HttpEventType {
User = 5,
}
/** @stable */
export declare abstract class HttpHandler {
abstract handle(req: HttpRequest<any>): Observable<HttpEvent<any>>;
}
/** @stable */
export declare class HttpHeaderResponse extends HttpResponseBase {
readonly type: HttpEventType.ResponseHeader;
constructor(init?: {
@ -1551,7 +1539,6 @@ export declare class HttpHeaderResponse extends HttpResponseBase {
}): HttpHeaderResponse;
}
/** @stable */
export declare class HttpHeaders {
constructor(headers?: string | {
[name: string]: string | string[];
@ -1565,12 +1552,10 @@ export declare class HttpHeaders {
set(name: string, value: string | string[]): HttpHeaders;
}
/** @stable */
export interface HttpInterceptor {
intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
}
/** @stable */
export interface HttpParameterCodec {
decodeKey(key: string): string;
decodeValue(value: string): string;
@ -1578,7 +1563,6 @@ export interface HttpParameterCodec {
encodeValue(value: string): string;
}
/** @stable */
export declare class HttpParams {
constructor(options?: HttpParamsOptions);
append(param: string, value: string): HttpParams;
@ -1591,14 +1575,12 @@ export declare class HttpParams {
toString(): string;
}
/** @stable */
export interface HttpProgressEvent {
loaded: number;
total?: number;
type: HttpEventType.DownloadProgress | HttpEventType.UploadProgress;
}
/** @stable */
export declare class HttpRequest<T> {
readonly body: T | null;
readonly headers: HttpHeaders;
@ -1667,7 +1649,6 @@ export declare class HttpRequest<T> {
serializeBody(): ArrayBuffer | Blob | FormData | string | null;
}
/** @stable */
export declare class HttpResponse<T> extends HttpResponseBase {
readonly body: T | null;
readonly type: HttpEventType.Response;
@ -1694,7 +1675,6 @@ export declare class HttpResponse<T> extends HttpResponseBase {
}): HttpResponse<V>;
}
/** @stable */
export declare abstract class HttpResponseBase {
readonly headers: HttpHeaders;
readonly ok: boolean;
@ -1710,12 +1690,10 @@ export declare abstract class HttpResponseBase {
}, defaultStatus?: number, defaultStatusText?: string);
}
/** @stable */
export interface HttpSentEvent {
type: HttpEventType.Sent;
}
/** @stable */
export declare class HttpUrlEncodingCodec implements HttpParameterCodec {
decodeKey(k: string): string;
decodeValue(v: string): string;
@ -1723,35 +1701,29 @@ export declare class HttpUrlEncodingCodec implements HttpParameterCodec {
encodeValue(v: string): string;
}
/** @stable */
export interface HttpUserEvent<T> {
type: HttpEventType.User;
}
/** @stable */
export declare class HttpXhrBackend implements HttpBackend {
constructor(xhrFactory: XhrFactory);
handle(req: HttpRequest<any>): Observable<HttpEvent<any>>;
}
/** @stable */
export declare abstract class HttpXsrfTokenExtractor {
abstract getToken(): string | null;
}
/** @stable */
export declare class JsonpClientBackend implements HttpBackend {
constructor(callbackMap: JsonpCallbackContext, document: any);
handle(req: HttpRequest<never>): Observable<HttpEvent<any>>;
}
/** @stable */
export declare class JsonpInterceptor {
constructor(jsonp: JsonpClientBackend);
intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
}
/** @stable */
export declare abstract class XhrFactory {
abstract build(): XMLHttpRequest;
}

4
tools/public_api_guard/common/http/testing.d.ts vendored
View File

@ -1,8 +1,6 @@
/** @stable */
export declare class HttpClientTestingModule {
}
/** @stable */
export declare abstract class HttpTestingController {
abstract expectNone(url: string, description?: string): void;
abstract expectNone(params: RequestMatch, description?: string): void;
@ -18,13 +16,11 @@ export declare abstract class HttpTestingController {
}): void;
}
/** @stable */
export interface RequestMatch {
method?: string;
url?: string;
}
/** @stable */
export declare class TestRequest {
readonly cancelled: boolean;
request: HttpRequest<any>;

1
tools/public_api_guard/common/testing.d.ts vendored
View File

@ -1,4 +1,3 @@
/** @stable */
export declare class MockLocationStrategy extends LocationStrategy {
internalBaseHref: string;
internalPath: string;