feat(core): add IdleRequestOptions support to IdleService

SkyZeroZx · thePunderWoman · commit 17d3ea44e25e · 2026-03-04T07:57:30.000-08:00
IdleService now accepts IdleRequestOptions,
enabling configuration of requestIdleCallback behavior in compatible environments.
diff --git a/goldens/public-api/core/index.api.md b/goldens/public-api/core/index.api.md
@@ -846,7 +846,7 @@ export interface HostListenerDecorator {
 // @public
 export interface IdleService {
     cancelOnIdle(id: number): void;
-    requestOnIdle(callback: (deadline?: IdleDeadline) => void): number;
+    requestOnIdle(callback: (deadline?: IdleDeadline) => void, options?: IdleRequestOptions): number;
 }
 
 // @public
diff --git a/packages/core/src/defer/idle_service.ts b/packages/core/src/defer/idle_service.ts
@@ -18,8 +18,14 @@ import {makeEnvironmentProviders} from '../di/provider_collection';
  * Note: we wrap the `requestIdleCallback` call into a function, so that it can be
  * overridden/mocked in test environment and picked up by the runtime code.
  */
-const _requestIdleCallback = () =>
-  (typeof requestIdleCallback !== 'undefined' ? requestIdleCallback : setTimeout).bind(globalThis);
+const _requestIdleCallback = (): ((
+  callback: (deadline?: IdleDeadline) => void,
+  options?: IdleRequestOptions,
+) => number) =>
+  typeof requestIdleCallback !== 'undefined'
+    ? requestIdleCallback.bind(globalThis)
+    : (callback) => setTimeout(callback) as unknown as number;
+
 const _cancelIdleCallback = () =>
   (typeof requestIdleCallback !== 'undefined' ? cancelIdleCallback : clearTimeout).bind(globalThis);
 
@@ -34,7 +40,7 @@ export interface IdleService {
    *
    * @returns an id which allows the scheduled callback to be cancelled before it executes.
    */
-  requestOnIdle(callback: (deadline?: IdleDeadline) => void): number;
+  requestOnIdle(callback: (deadline?: IdleDeadline) => void, options?: IdleRequestOptions): number;
 
   /**
    * Cancel a previously scheduled callback using the id associated with it.
@@ -74,8 +80,8 @@ class RequestIdleCallbackService implements IdleService {
   private readonly requestIdleCallback = _requestIdleCallback();
   private readonly cancelIdleCallback = _cancelIdleCallback();
 
-  requestOnIdle(callback: (deadline?: IdleDeadline) => void): number {
-    return this.requestIdleCallback(callback) as unknown as number;
+  requestOnIdle(callback: (deadline?: IdleDeadline) => void, options?: IdleRequestOptions): number {
+    return this.requestIdleCallback(callback, options);
   }
 
   cancelOnIdle(id: number): void {

Original file line number	Diff line number	Diff line change
`@@ -846,7 +846,7 @@ export interface HostListenerDecorator {`
`846`	`846`	`// @public`
`847`	`847`	`export interface IdleService {`
`848`	`848`	`cancelOnIdle(id: number): void;`
`849`		`- requestOnIdle(callback: (deadline?: IdleDeadline) => void): number;`
	`849`	`+ requestOnIdle(callback: (deadline?: IdleDeadline) => void, options?: IdleRequestOptions): number;`
`850`	`850`	`}`
`851`	`851`
`852`	`852`	`// @public`