prefetchPageResources( )

I see that a new API prefetchPageResources( ) was released. Besides the description that was on the reference sheet, are there any other details that can be provided about how it affects loading time for the current page and if it preloads a page even if they are on that current page?

Provided Description
Optimizes resource fetching of pages and lightboxes in the site so they will load faster.

Description

Use the prefetchPageResources() function to optimize resource fetching of pages and lightboxes you think your site visitors are likely to visit next. When the site visitor navigates to those pages or lightboxes, they will load quicker than usual since some of their resources have already been retrieved.

You can only prefetch resources from pages or lightboxes within the current site.
A prefetch is considered successful if the specified pages and lightboxes exist in the current site. If any of the specified pages or lightboxes do not exist, the prefetch operation returns an error status and lists of the pages and lightboxes that were not found.

Hi,
prefetchPageResources( ) is indeed helpful when it comes to loading time as the function loads resources of certain pages in the background before the user actually tries to access the page.

However note that this function is only useful for the current site’s pages. If you try to prefetch pages or lightboxes that do not exist - you will get an error.

Currently, the API reference is the only documentation about the prefetchPageResources( ) function.