Edge Functions API Reference

Edge Functions run on the Edge Runtime, a runtime built on top of the V8 JavaScript engine. To learn more about the Edge Runtime and its supported APIs, see the Edge Runtime documentation.

The config object is used to configure your Edge Function in Next.js pages router and Edge Functions for non-Next.js frameworks.

• The runtime property is required, and must be set to edge to run your function on the Edge Runtime
• The regions property is optional and can be used to specify the region to which your function should be deployed. By default, your function will be deployed to all regions

export const config = {
  runtime: 'edge',
  regions: 'iad1', // optional
};

When using the app router in Next.js, you must configure your Edge Function with segment options rather than a config object.

• The runtime option is required, and must be set to 'edge' to run your function on the Edge Runtime
• The preferredRegion option is optional and can be used to specify the region to which your function should be deployed. By default, your function will be deployed to all regions

export const runtime = 'edge';
export const dynamic = 'auto';
export const dynamicParams = true;
export const revalidate = false;
export const fetchCache = 'auto';
export const preferredRegion = 'auto';
export const maxDuration = 5;
 
export default function MyComponent() {}

The Edge Functions signature is made up of two parameters: request and context. The request parameter is an instance of the Request object, and the context parameter is an object containing the waitUntil method.

export const runtime = 'edge';
 
export function GET(request: Request) {
  return Response.json({
    name: `Hello, from ${request.url} I'm an Edge Function!`,
  });
}

The Request object represents an HTTP request. It is a wrapper around the Fetch API Request object.

To learn more about the NextRequest object and its properties, visit the Next.js documentation.

Learn more about Edge Functions by exploring the following resources:

• Deploy a template
• Edge Functions usage and pricing
• Edge Functions limitations