how to use disableCorePrefetching? true or false?

[TylerBarnes]

Summary

I'm building a starter/plugin that allows for previewing changes in a WordPress source gatsby site. I'm generating a preview version of the site to be used by WP and I want to disable prefetching since I'm also going to disable navigation from previews. The docs are a little unclear on how to use this api. When I just return true or false to it, it breaks. If I return a function which returns a bool, it doesn't say anything.

I'm wondering if I should be returning true or false or something else entirely.

Thanks!

[kakadiadarpan]

@TylerBarnes Please check the below code snippet where disableCorePrefetching is being used. It is exporting a function which returns a boolean

gatsby/packages/gatsby-plugin-guess-js/src/gatsby-browser.js

Lines 1 to 29 in 2605aa0

	const { guess } = require(`guess-webpack/api`)
	exports.disableCorePrefetching = () => true
	let initialPath
	let notNavigated = true
	exports.onRouteUpdate = ({ location }) => {
	if (initialPath !== location.pathname) {
	notNavigated = false
	return
	}
	initialPath = location.pathname
	}
	exports.onPrefetchPathname = ({ getResourcesForPathname }, pluginOptions) => {
	if (process.env.NODE_ENV !== `production`) return
	const matchedPaths = Object.keys(
	guess({
	path: window.location.pathname,
	threshold: pluginOptions.minimumThreshold,
	})
	)
	// Don't prefetch from client for the initial path as we did that
	// during SSR
	if (!(notNavigated && initialPath === window.location.pathname))
	matchedPaths.forEach(getResourcesForPathname)
	}

[kakadiadarpan]

Also, would you like to raise a PR to fix the documentation for the same? I would be happy to help you out if you are interested.

[TylerBarnes]

I'll make a PR for sure!