@angular/core

onIdle

function

stablesince v22.0

A PrefetchTrigger helper function to provide the logic of triggering dependency loading when the browser becomes idle.

API

function onIdle(
  options?: { timeout?: number | undefined } | undefined,
): Promise<void>;

@paramoptions{ timeout?: number | undefined; } | undefined

@returnsPromise<void>

Description

A PrefetchTrigger helper function to provide the logic of triggering dependency loading when the browser becomes idle.

Internally delegates to the configured IdleService, whose default implementation uses requestIdleCallback when available and falls back to setTimeout otherwise. The default behavior can be replaced with provideIdleServiceWith.

Usage Notes

injectAsync(import(...), {prefetch: onIdle})

// or with custom idle options:
injectAsync(import(...), {prefetch: () => onIdle({timeout: 100})})