docs: convert all @experimental
tags to @publicApi
tags (#26595)
PR Close #26595
This commit is contained in:

committed by
Alex Rickabaugh

parent
4bd9f53e8f
commit
24521f549c
@ -262,7 +262,7 @@ export type Routes = Route[];
|
||||
* * `consumed` is an array of the consumed URL segments.
|
||||
* * `posParams` is a map of positional parameters.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export type UrlMatchResult = {
|
||||
consumed: UrlSegment[]; posParams?: {[name: string]: UrlSegment};
|
||||
@ -286,7 +286,7 @@ export type UrlMatchResult = {
|
||||
* export const routes = [{ matcher: htmlFiles, component: AnyComponent }];
|
||||
* ```
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export type UrlMatcher = (segments: UrlSegment[], group: UrlSegmentGroup, route: Route) =>
|
||||
UrlMatchResult;
|
||||
@ -352,7 +352,7 @@ export type QueryParamsHandling = 'merge' | 'preserve' | '';
|
||||
* The type of `runGuardsAndResolvers`.
|
||||
*
|
||||
* See `Routes` for more details.
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export type RunGuardsAndResolvers = 'paramsChange' | 'paramsOrQueryParamsChange' | 'always';
|
||||
|
||||
|
@ -18,7 +18,7 @@ import {ActivatedRouteSnapshot, RouterStateSnapshot} from './router_state';
|
||||
* * 'popstate'--triggered by a popstate event
|
||||
* * 'hashchange'--triggered by a hashchange event
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export type NavigationTrigger = 'imperative' | 'popstate' | 'hashchange';
|
||||
|
||||
@ -40,7 +40,7 @@ export type NavigationTrigger = 'imperative' | 'popstate' | 'hashchange';
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class RouterEvent {
|
||||
constructor(
|
||||
@ -200,7 +200,7 @@ export class RoutesRecognized extends RouterEvent {
|
||||
*
|
||||
* Represents the start of the Guard phase of routing.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class GuardsCheckStart extends RouterEvent {
|
||||
constructor(
|
||||
@ -225,7 +225,7 @@ export class GuardsCheckStart extends RouterEvent {
|
||||
*
|
||||
* Represents the end of the Guard phase of routing.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class GuardsCheckEnd extends RouterEvent {
|
||||
constructor(
|
||||
@ -255,7 +255,7 @@ export class GuardsCheckEnd extends RouterEvent {
|
||||
* in the "resolve" phase whether there's things to resolve or not. In the future this
|
||||
* behavior may change to only run when there are things to be resolved.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class ResolveStart extends RouterEvent {
|
||||
constructor(
|
||||
@ -281,7 +281,7 @@ export class ResolveStart extends RouterEvent {
|
||||
* Represents the end of the Resolve phase of routing. See note on
|
||||
* `ResolveStart` for use of this experimental API.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class ResolveEnd extends RouterEvent {
|
||||
constructor(
|
||||
@ -306,7 +306,7 @@ export class ResolveEnd extends RouterEvent {
|
||||
*
|
||||
* Represents an event triggered before lazy loading a route config.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class RouteConfigLoadStart {
|
||||
constructor(
|
||||
@ -320,7 +320,7 @@ export class RouteConfigLoadStart {
|
||||
*
|
||||
* Represents an event triggered when a route has been lazy loaded.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class RouteConfigLoadEnd {
|
||||
constructor(
|
||||
@ -335,7 +335,7 @@ export class RouteConfigLoadEnd {
|
||||
* Represents the start of end of the Resolve phase of routing. See note on
|
||||
* `ChildActivationEnd` for use of this experimental API.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class ChildActivationStart {
|
||||
constructor(
|
||||
@ -353,7 +353,7 @@ export class ChildActivationStart {
|
||||
* Represents the start of end of the Resolve phase of routing. See note on
|
||||
* `ChildActivationStart` for use of this experimental API.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class ChildActivationEnd {
|
||||
constructor(
|
||||
@ -371,7 +371,7 @@ export class ChildActivationEnd {
|
||||
* Represents the start of end of the Resolve phase of routing. See note on
|
||||
* `ActivationEnd` for use of this experimental API.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class ActivationStart {
|
||||
constructor(
|
||||
@ -389,7 +389,7 @@ export class ActivationStart {
|
||||
* Represents the start of end of the Resolve phase of routing. See note on
|
||||
* `ActivationStart` for use of this experimental API.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class ActivationEnd {
|
||||
constructor(
|
||||
|
@ -20,7 +20,7 @@ import {TreeNode} from './utils/tree';
|
||||
* This is an opaque value the router will give to a custom route reuse strategy
|
||||
* to store and retrieve later on.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export type DetachedRouteHandle = {};
|
||||
|
||||
@ -36,7 +36,7 @@ export type DetachedRouteHandleInternal = {
|
||||
*
|
||||
* Provides a way to customize when activated routes get reused.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export abstract class RouteReuseStrategy {
|
||||
/** Determines if this route (and its subtree) should be detached to be reused later */
|
||||
|
@ -15,7 +15,7 @@ import {flatten, wrapIntoObservable} from './utils/collection';
|
||||
|
||||
/**
|
||||
* @docsNotRequired
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export const ROUTES = new InjectionToken<Route[][]>('ROUTES');
|
||||
|
||||
|
@ -268,7 +268,7 @@ export function provideRoutes(routes: Routes): any {
|
||||
*
|
||||
* The 'legacy_enabled' and 'legacy_disabled' should not be used for new applications.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export type InitialNavigation =
|
||||
true | false | 'enabled' | 'disabled' | 'legacy_enabled' | 'legacy_disabled';
|
||||
@ -608,7 +608,7 @@ export function getBootstrapListener(r: RouterInitializer) {
|
||||
/**
|
||||
* A token for the router initializer that will be called after the app is bootstrapped.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export const ROUTER_INITIALIZER =
|
||||
new InjectionToken<(compRef: ComponentRef<any>) => void>('Router Initializer');
|
||||
|
@ -21,7 +21,7 @@ import {RouterConfigLoader} from './router_config_loader';
|
||||
*
|
||||
* Provides a preloading strategy.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export abstract class PreloadingStrategy {
|
||||
abstract preload(route: Route, fn: () => Observable<any>): Observable<any>;
|
||||
@ -36,7 +36,7 @@ export abstract class PreloadingStrategy {
|
||||
* RouteModule.forRoot(ROUTES, {preloadingStrategy: PreloadAllModules})
|
||||
* ```
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class PreloadAllModules implements PreloadingStrategy {
|
||||
preload(route: Route, fn: () => Observable<any>): Observable<any> {
|
||||
@ -51,7 +51,7 @@ export class PreloadAllModules implements PreloadingStrategy {
|
||||
*
|
||||
* This strategy is enabled by default.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class NoPreloading implements PreloadingStrategy {
|
||||
preload(route: Route, fn: () => Observable<any>): Observable<any> { return of (null); }
|
||||
|
@ -13,7 +13,7 @@ import {UrlTree} from './url_tree';
|
||||
*
|
||||
* Provides a way to migrate AngularJS applications to Angular.
|
||||
*
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export abstract class UrlHandlingStrategy {
|
||||
/**
|
||||
@ -39,7 +39,7 @@ export abstract class UrlHandlingStrategy {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental
|
||||
* @publicApi
|
||||
*/
|
||||
export class DefaultUrlHandlingStrategy implements UrlHandlingStrategy {
|
||||
shouldProcessUrl(url: UrlTree): boolean { return true; }
|
||||
|
Reference in New Issue
Block a user