NEXTJS_NO_ASYNC_PAGE

Ensures that the exported Next.js page component and its transitive dependencies are not asynchronous, as that blocks the rendering of the page.
Table of Contents

Conformance is available on Enterprise plans

This rule is in preview, please give us your feedback!

This rule is available from version 1.1.0.

This rule examines all Next.js app router page files and their transitive dependencies to ensure none are asynchronous or return new Promise instances. Even if the page component itself is not asynchronous, importing an asynchronous component somewhere in the page's dependency tree can silently cause the page to render dynamically. This can cause a blank page to be displayed to the user while Next.js waits for long promises to resolve.

This rule will not error if it detects a sibling loading.js file beside the page.

By default, this rule is disabled. To enable it, refer to customizing Conformance.

For further reading, you may find these resources helpful:

This rule will catch the following code.

app/page.tsx
export default async function Page() {
  const data = await fetch();
  return <div>{data}</div>;
}
app/page.jsx
async function AuthButton() {
  const isAuthorized = await auth();
  return <div>{isAuthorized ? 'Authorized' : 'Unauthorized'}</div>;
}
 
export default function Page() {
  return <AuthButton />;
}

You can fix this error by wrapping your async component with a <Suspense/> boundary that has a fallback UI to indicate to Next.js that it should use the fallback until the promise resolves.

Alternatively, you can manually force the dynamic behaviour of the page by exporting a dynamic value. This rule will only error if dynamic is not specified or is set to auto. Read more here.

app/page.tsx
export const dynamic = 'force-static';
 
export default async function Page() {
  const data = await fetch();
  return <div>{data}</div>;
}
Last updated on July 23, 2024