NgDocPreloadingStrategy

The router preloading strategy of NgDoc: it loads a lazy route only when the reader is about to open one of its pages, as NgDocRoutePreloader decides, instead of every route at once.

Set it as the router's preloading strategy to preload pages on intent:

provideRouter(routes, withPreloading(NgDocPreloadingStrategy));

Decorators: @Service
Implements: PreloadingStrategy

DeclarationTypeScript

@Service()
export class NgDocPreloadingStrategy implements PreloadingStrategy { … }

Members

Constructor

()

—

Signature

constructor(
	
): NgDocPreloadingStrategy;

Methods

(…): Observable<unknown>

implements PreloadingStrategy

Loads a lazy route when it leads to a page that is being preloaded.

Signature

preload(route: Route, load: () => Observable<unknown>): Observable<unknown>;

Parameters

Name	Type	Description
route	`Route`	A lazy route that the router has not loaded yet.
load	`() => Observable<unknown>`	Loads the route.

Returns

Observable<unknown> -

The load, or an observable of null when the route is not loaded now.

Symbol

Kind: Class
Decorators: @Service
Implements: PreloadingStrategy
Scope: @ng-doc/app

Edit this page