docs: remove all deprecated @stable jsdoc tags (#23210)
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
committed by
Igor Minar
Igor Minar
parent
ee145790d7
commit
4b96a58c5a
44
tools/public_api_guard/router/router.d.ts
vendored
44
tools/public_api_guard/router/router.d.ts
vendored
@ -1,4 +1,3 @@
|
||||
/** @stable */
|
||||
export declare class ActivatedRoute {
|
||||
readonly children: ActivatedRoute[];
|
||||
component: Type<any> | string | null;
|
||||
@ -19,7 +18,6 @@ export declare class ActivatedRoute {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class ActivatedRouteSnapshot {
|
||||
readonly children: ActivatedRouteSnapshot[];
|
||||
component: Type<any> | string | null;
|
||||
@ -55,22 +53,18 @@ export declare class ActivationStart {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export interface CanActivate {
|
||||
canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean> | Promise<boolean> | boolean;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export interface CanActivateChild {
|
||||
canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean> | Promise<boolean> | boolean;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export interface CanDeactivate<T> {
|
||||
canDeactivate(component: T, currentRoute: ActivatedRouteSnapshot, currentState: RouterStateSnapshot, nextState?: RouterStateSnapshot): Observable<boolean> | Promise<boolean> | boolean;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export interface CanLoad {
|
||||
canLoad(route: Route): Observable<boolean> | Promise<boolean> | boolean;
|
||||
}
|
||||
@ -91,7 +85,6 @@ export declare class ChildActivationStart {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class ChildrenOutletContexts {
|
||||
getContext(childName: string): OutletContext | null;
|
||||
getOrCreateContext(childName: string): OutletContext;
|
||||
@ -101,15 +94,12 @@ export declare class ChildrenOutletContexts {
|
||||
onOutletReAttached(contexts: Map<string, OutletContext>): void;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare function convertToParamMap(params: Params): ParamMap;
|
||||
|
||||
/** @stable */
|
||||
export declare type Data = {
|
||||
[name: string]: any;
|
||||
};
|
||||
|
||||
/** @stable */
|
||||
export declare class DefaultUrlSerializer implements UrlSerializer {
|
||||
parse(url: string): UrlTree;
|
||||
serialize(tree: UrlTree): string;
|
||||
@ -118,10 +108,8 @@ export declare class DefaultUrlSerializer implements UrlSerializer {
|
||||
/** @experimental */
|
||||
export declare type DetachedRouteHandle = {};
|
||||
|
||||
/** @stable */
|
||||
export declare type Event = RouterEvent | RouteConfigLoadStart | RouteConfigLoadEnd | ChildActivationStart | ChildActivationEnd | ActivationStart | ActivationEnd;
|
||||
|
||||
/** @stable */
|
||||
export interface ExtraOptions {
|
||||
enableTracing?: boolean;
|
||||
errorHandler?: ErrorHandler;
|
||||
@ -158,13 +146,10 @@ export declare class GuardsCheckStart extends RouterEvent {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare type LoadChildren = string | LoadChildrenCallback;
|
||||
|
||||
/** @stable */
|
||||
export declare type LoadChildrenCallback = () => Type<any> | NgModuleFactory<any> | Promise<Type<any>> | Observable<Type<any>>;
|
||||
|
||||
/** @stable */
|
||||
export declare class NavigationCancel extends RouterEvent {
|
||||
reason: string;
|
||||
constructor(
|
||||
@ -174,7 +159,6 @@ export declare class NavigationCancel extends RouterEvent {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class NavigationEnd extends RouterEvent {
|
||||
urlAfterRedirects: string;
|
||||
constructor(
|
||||
@ -184,7 +168,6 @@ export declare class NavigationEnd extends RouterEvent {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class NavigationError extends RouterEvent {
|
||||
error: any;
|
||||
constructor(
|
||||
@ -194,7 +177,6 @@ export declare class NavigationError extends RouterEvent {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export interface NavigationExtras {
|
||||
fragment?: string;
|
||||
preserveFragment?: boolean;
|
||||
@ -206,7 +188,6 @@ export interface NavigationExtras {
|
||||
skipLocationChange?: boolean;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class NavigationStart extends RouterEvent {
|
||||
navigationTrigger?: 'imperative' | 'popstate' | 'hashchange';
|
||||
restoredState?: {
|
||||
@ -227,7 +208,6 @@ export declare class NoPreloading implements PreloadingStrategy {
|
||||
preload(route: Route, fn: () => Observable<any>): Observable<any>;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class OutletContext {
|
||||
attachRef: ComponentRef<any> | null;
|
||||
children: ChildrenOutletContexts;
|
||||
@ -236,7 +216,6 @@ export declare class OutletContext {
|
||||
route: ActivatedRoute | null;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export interface ParamMap {
|
||||
readonly keys: string[];
|
||||
get(name: string): string | null;
|
||||
@ -244,7 +223,6 @@ export interface ParamMap {
|
||||
has(name: string): boolean;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare type Params = {
|
||||
[key: string]: any;
|
||||
};
|
||||
@ -259,18 +237,14 @@ export declare abstract class PreloadingStrategy {
|
||||
abstract preload(route: Route, fn: () => Observable<any>): Observable<any>;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare const PRIMARY_OUTLET = "primary";
|
||||
|
||||
/** @stable */
|
||||
export declare function provideRoutes(routes: Routes): any;
|
||||
|
||||
/** @stable */
|
||||
export interface Resolve<T> {
|
||||
resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<T> | Promise<T> | T;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare type ResolveData = {
|
||||
[name: string]: any;
|
||||
};
|
||||
@ -299,7 +273,6 @@ export declare class ResolveStart extends RouterEvent {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export interface Route {
|
||||
canActivate?: any[];
|
||||
canActivateChild?: any[];
|
||||
@ -334,7 +307,6 @@ export declare class RouteConfigLoadStart {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class Router {
|
||||
config: Routes;
|
||||
errorHandler: ErrorHandler;
|
||||
@ -360,7 +332,6 @@ export declare class Router {
|
||||
setUpLocationChangeListener(): void;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare const ROUTER_CONFIGURATION: InjectionToken<ExtraOptions>;
|
||||
|
||||
/** @experimental */
|
||||
@ -384,7 +355,6 @@ export declare class RouterEvent {
|
||||
url: string);
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class RouterLink {
|
||||
fragment: string;
|
||||
preserveFragment: boolean;
|
||||
@ -401,7 +371,6 @@ export declare class RouterLink {
|
||||
onClick(): boolean;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class RouterLinkActive implements OnChanges, OnDestroy, AfterContentInit {
|
||||
readonly isActive: boolean;
|
||||
links: QueryList<RouterLink>;
|
||||
@ -416,7 +385,6 @@ export declare class RouterLinkActive implements OnChanges, OnDestroy, AfterCont
|
||||
ngOnDestroy(): void;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class RouterLinkWithHref implements OnChanges, OnDestroy {
|
||||
fragment: string;
|
||||
href: string;
|
||||
@ -437,14 +405,12 @@ export declare class RouterLinkWithHref implements OnChanges, OnDestroy {
|
||||
onClick(button: number, ctrlKey: boolean, metaKey: boolean, shiftKey: boolean): boolean;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class RouterModule {
|
||||
constructor(guard: any, router: Router);
|
||||
static forChild(routes: Routes): ModuleWithProviders;
|
||||
static forRoot(routes: Routes, config?: ExtraOptions): ModuleWithProviders;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class RouterOutlet implements OnDestroy, OnInit {
|
||||
activateEvents: EventEmitter<any>;
|
||||
readonly activatedRoute: ActivatedRoute;
|
||||
@ -463,7 +429,6 @@ export declare class RouterOutlet implements OnDestroy, OnInit {
|
||||
ngOnInit(): void;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class RouterPreloader implements OnDestroy {
|
||||
constructor(router: Router, moduleLoader: NgModuleFactoryLoader, compiler: Compiler, injector: Injector, preloadingStrategy: PreloadingStrategy);
|
||||
ngOnDestroy(): void;
|
||||
@ -471,25 +436,21 @@ export declare class RouterPreloader implements OnDestroy {
|
||||
setUpPreloading(): void;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class RouterState extends Tree<ActivatedRoute> {
|
||||
snapshot: RouterStateSnapshot;
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class RouterStateSnapshot extends Tree<ActivatedRouteSnapshot> {
|
||||
url: string;
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare type Routes = Route[];
|
||||
|
||||
/** @experimental */
|
||||
export declare const ROUTES: InjectionToken<Route[][]>;
|
||||
|
||||
/** @stable */
|
||||
export declare class RoutesRecognized extends RouterEvent {
|
||||
state: RouterStateSnapshot;
|
||||
urlAfterRedirects: string;
|
||||
@ -522,7 +483,6 @@ export declare type UrlMatchResult = {
|
||||
};
|
||||
};
|
||||
|
||||
/** @stable */
|
||||
export declare class UrlSegment {
|
||||
readonly parameterMap: ParamMap;
|
||||
parameters: {
|
||||
@ -537,7 +497,6 @@ export declare class UrlSegment {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class UrlSegmentGroup {
|
||||
children: {
|
||||
[key: string]: UrlSegmentGroup;
|
||||
@ -554,13 +513,11 @@ export declare class UrlSegmentGroup {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare abstract class UrlSerializer {
|
||||
abstract parse(url: string): UrlTree;
|
||||
abstract serialize(tree: UrlTree): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare class UrlTree {
|
||||
fragment: string | null;
|
||||
readonly queryParamMap: ParamMap;
|
||||
@ -571,5 +528,4 @@ export declare class UrlTree {
|
||||
toString(): string;
|
||||
}
|
||||
|
||||
/** @stable */
|
||||
export declare const VERSION: Version;
|
||||
|
||||
Reference in New Issue
Block a user