Methods

Chrome DevTools

Preload.disable #


Chrome DevTools

Preload.enable #

Events

Chrome DevTools

Preload.prefetchStatusUpdated #

Fired when a prefetch attempt is updated.

Parameters

initiatingFrameId
Page.FrameId

The frame id of the frame initiating prefetch.

prefetchUrl
string
prefetchStatus

Chrome DevTools

Preload.preloadEnabledStateUpdated #

Fired when a preload enabled state is updated.

Parameters

disabledByPreference
boolean
disabledByDataSaver
boolean
disabledByBatterySaver
boolean
disabledByHoldbackPrefetchSpeculationRules
boolean
disabledByHoldbackPrerenderSpeculationRules
boolean

Chrome DevTools

Preload.preloadingAttemptSourcesUpdated #

Send a list of sources for all preloading attempts in a document.

Parameters

preloadingAttemptSources

Chrome DevTools

Preload.prerenderStatusUpdated #

Fired when a prerender attempt is updated.

Parameters

prerenderStatus
Optional
disallowedMojoInterface
Optional
string

This is used to give users more information about the name of Mojo interface that is incompatible with prerender and has caused the cancellation of the attempt.

mismatchedHeaders
Optional

Chrome DevTools

Preload.ruleSetRemoved #

Parameters


Chrome DevTools

Preload.ruleSetUpdated #

Upsert. Currently, it is only emitted when a rule set added.

Parameters

ruleSet

Types

Chrome DevTools

Preload.PrefetchStatus #

TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and filter out the ones that aren't necessary to the developers.

Type: string

Allowed values: PrefetchAllowed, PrefetchFailedIneligibleRedirect, PrefetchFailedInvalidRedirect, PrefetchFailedMIMENotSupported, PrefetchFailedNetError, PrefetchFailedNon2XX, PrefetchFailedPerPageLimitExceeded, PrefetchEvictedAfterCandidateRemoved, PrefetchEvictedForNewerPrefetch, PrefetchHeldback, PrefetchIneligibleRetryAfter, PrefetchIsPrivacyDecoy, PrefetchIsStale, PrefetchNotEligibleBrowserContextOffTheRecord, PrefetchNotEligibleDataSaverEnabled, PrefetchNotEligibleExistingProxy, PrefetchNotEligibleHostIsNonUnique, PrefetchNotEligibleNonDefaultStoragePartition, PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy, PrefetchNotEligibleSchemeIsNotHttps, PrefetchNotEligibleUserHasCookies, PrefetchNotEligibleUserHasServiceWorker, PrefetchNotEligibleBatterySaverEnabled, PrefetchNotEligiblePreloadingDisabled, PrefetchNotFinishedInTime, PrefetchNotStarted, PrefetchNotUsedCookiesChanged, PrefetchProxyNotAvailable, PrefetchResponseUsed, PrefetchSuccessfulButNotUsed, PrefetchNotUsedProbeFailed


Chrome DevTools

Preload.PreloadingAttemptKey #

A key that identifies a preloading attempt.

The url used is the url specified by the trigger (i.e. the initial URL), and not the final url that is navigated to. For example, prerendering allows same-origin main frame navigations during the attempt, but the attempt is still keyed with the initial URL.

Type: object

Properties

url
string
targetHint
Optional

Chrome DevTools

Preload.PreloadingAttemptSource #

Lists sources for a preloading attempt, specifically the ids of rule sets that had a speculation rule that triggered the attempt, and the BackendNodeIds of or elements that triggered the attempt (in the case of attempts triggered by a document rule). It is possible for multiple rule sets and links to trigger a single attempt.

Type: object

Properties

ruleSetIds
array[ RuleSetId ]
nodeIds

Chrome DevTools

Preload.PreloadingStatus #

Preloading status values, see also PreloadingTriggeringOutcome. This status is shared by prefetchStatusUpdated and prerenderStatusUpdated.

Type: string

Allowed values: Pending, Running, Ready, Success, Failure, NotSupported


Chrome DevTools

Preload.PrerenderFinalStatus #

List of FinalStatus reasons for Prerender2.

Type: string

Allowed values: Activated, Destroyed, LowEndDevice, InvalidSchemeRedirect, InvalidSchemeNavigation, NavigationRequestBlockedByCsp, MainFrameNavigation, MojoBinderPolicy, RendererProcessCrashed, RendererProcessKilled, Download, TriggerDestroyed, NavigationNotCommitted, NavigationBadHttpStatus, ClientCertRequested, NavigationRequestNetworkError, CancelAllHostsForTesting, DidFailLoad, Stop, SslCertificateError, LoginAuthRequested, UaChangeRequiresReload, BlockedByClient, AudioOutputDeviceRequested, MixedContent, TriggerBackgrounded, MemoryLimitExceeded, DataSaverEnabled, TriggerUrlHasEffectiveUrl, ActivatedBeforeStarted, InactivePageRestriction, StartFailed, TimeoutBackgrounded, CrossSiteRedirectInInitialNavigation, CrossSiteNavigationInInitialNavigation, SameSiteCrossOriginRedirectNotOptInInInitialNavigation, SameSiteCrossOriginNavigationNotOptInInInitialNavigation, ActivationNavigationParameterMismatch, ActivatedInBackground, EmbedderHostDisallowed, ActivationNavigationDestroyedBeforeSuccess, TabClosedByUserGesture, TabClosedWithoutUserGesture, PrimaryMainFrameRendererProcessCrashed, PrimaryMainFrameRendererProcessKilled, ActivationFramePolicyNotCompatible, PreloadingDisabled, BatterySaverEnabled, ActivatedDuringMainFrameNavigation, PreloadingUnsupportedByWebContents, CrossSiteRedirectInMainFrameNavigation, CrossSiteNavigationInMainFrameNavigation, SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation, SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation, MemoryPressureOnTrigger, MemoryPressureAfterTriggered, PrerenderingDisabledByDevTools, SpeculationRuleRemoved, ActivatedWithAuxiliaryBrowsingContexts, MaxNumOfRunningEagerPrerendersExceeded, MaxNumOfRunningNonEagerPrerendersExceeded, MaxNumOfRunningEmbedderPrerendersExceeded, PrerenderingUrlHasEffectiveUrl, RedirectedPrerenderingUrlHasEffectiveUrl, ActivationUrlHasEffectiveUrl, JavaScriptInterfaceAdded, JavaScriptInterfaceRemoved, AllPrerenderingCanceled


Chrome DevTools

Preload.PrerenderMismatchedHeaders #

Information of headers to be displayed when the header mismatch occurred.

Type: object

Properties

headerName
string
initialValue
Optional
string
activationValue
Optional
string

Chrome DevTools

Preload.RuleSet #

Corresponds to SpeculationRuleSet

Type: object

Properties

loaderId
Network.LoaderId

Identifies a document which the rule set is associated with.

sourceText
string

Source text of JSON representing the rule set. If it comes from <script> tag, it is the textContent of the node. Note that it is a JSON for valid case.

See also:

  • https://wicg.github.io/nav-speculation/speculation-rules.html
  • https://github.com/WICG/nav-speculation/blob/main/triggers.md
backendNodeId
Optional
DOM.BackendNodeId

A speculation rule set is either added through an inline <script> tag or through an external resource via the 'Speculation-Rules' HTTP header. For the first case, we include the BackendNodeId of the relevant <script> tag. For the second case, we include the external URL where the rule set was loaded from, and also RequestId if Network domain is enabled.

See also:

  • https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script
  • https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header
url
Optional
string
requestId
Optional
errorType
Optional
RuleSetErrorType

Error information errorMessage is null iff errorType is null.

errorMessage
Optional
string

TODO(https://crbug.com/1425354): Replace this property with structured error.

Deprecated

Chrome DevTools

Preload.RuleSetErrorType #

Type: string

Allowed values: SourceIsNotJsonObject, InvalidRulesSkipped


Chrome DevTools

Preload.RuleSetId #

Unique id

Type: string


Chrome DevTools

Preload.SpeculationAction #

The type of preloading attempted. It corresponds to mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it isn't being used by clients).

Type: string

Allowed values: Prefetch, Prerender


Chrome DevTools

Preload.SpeculationTargetHint #

Corresponds to mojom::SpeculationTargetHint. See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints

Type: string

Allowed values: Blank, Self