Skip to content

Add TypeScript declarations for requestIdleCallback and cancelIdleCallback #57545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Critteros wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add TypeScript declarations for requestIdleCallback and cancelIdleCallback #57545

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
847ae94
Add TypeScript declarations for requestIdleCallback and cancelIdleCal…
Critteros Jul 14, 2026
dcbca37
use number for requestIdleCallback handle
Critteros Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions packages/react-native/__typetests__/globals.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,25 @@ function testRequestAnimationFrame(){
);
}

function testRequestIdleCallback() {
let handle = requestIdleCallback(deadline => {
const didTimeout: boolean = deadline.didTimeout;
const remaining: number = deadline.timeRemaining();
console.log(didTimeout, remaining);
});
cancelIdleCallback(handle);

handle = requestIdleCallback(noop, { timeout: 100 });
cancelIdleCallback(handle);

// @ts-expect-error
requestIdleCallback(noop, { timeout: 'wrong-type' });

// handle is opaque: object on New Architecture, number on legacy
// @ts-expect-error
const handleIsNotNumber: number = requestIdleCallback(noop);
}

const fetchCopy: WindowOrWorkerGlobalScope['fetch'] = fetch;

const myHeaders = new Headers();
Expand Down
10 changes: 10 additions & 0 deletions packages/react-native/src/types/globals.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,16 @@ declare global {
function cancelAnimationFrame(handle: number | null | undefined): void;
function requestAnimationFrame(callback: (time: number) => void): number;

type IdleCallbackID = unknown;
Comment thread
Critteros marked this conversation as resolved.
Outdated
function requestIdleCallback(
callback: (deadline: {
didTimeout: boolean;
timeRemaining: () => number;
}) => void,
options?: {timeout: number},
): IdleCallbackID;
function cancelIdleCallback(handle: IdleCallbackID): void;

function fetchBundle(
bundleId: number,
callback: (error?: Error | null) => void,
Expand Down