Skip to main content

NextRequest

NextRequest extends the Web Request API with additional convenience methods.

cookies​

Read or mutate the Set-Cookie header of the request.

set(name, value)​

Given a name, set a cookie with the given value on the request.

// Given incoming request /home
// Set a cookie to hide the banner
// request will have a `Set-Cookie:show-banner=false;path=/home` header
request.cookies.set('show-banner', 'false')

get(name)​

Given a cookie name, return the value of the cookie. If the cookie is not found, undefined is returned. If multiple cookies are found, the first one is returned.

// Given incoming request /home
// { name: 'show-banner', value: 'false', Path: '/home' }
request.cookies.get('show-banner')

getAll()​

Given a cookie name, return the values of the cookie. If no name is given, return all cookies on the request.

// Given incoming request /home
// [
// { name: 'experiments', value: 'new-pricing-page', Path: '/home' },
// { name: 'experiments', value: 'winter-launch', Path: '/home' },
// ]
request.cookies.getAll('experiments')
// Alternatively, get all cookies for the request
request.cookies.getAll()

delete(name)​

Given a cookie name, delete the cookie from the request.

// Returns true for deleted, false is nothing is deleted
request.cookies.delete('experiments')

has(name)​

Given a cookie name, return true if the cookie exists on the request.

// Returns true if cookie exists, false if it does not
request.cookies.has('experiments')

clear()​

Remove the Set-Cookie header from the request.

request.cookies.clear()

nextUrl​

Extends the native URL API with additional convenience methods, including Next.js specific properties.

// Given a request to /home, pathname is /home
request.nextUrl.pathname
// Given a request to /home?name=lee, searchParams is { 'name': 'lee' }
request.nextUrl.searchParams

The following options are available:

PropertyTypeDescription
basePathstringThe base path of the URL.
buildIdstring | undefinedThe build identifier of the Next.js application. Can be customized.
defaultLocalestring | undefinedThe default locale for internationalization.
domainLocale
- defaultLocalestringThe default locale within a domain.
- domainstringThe domain associated with a specific locale.
- httpboolean | undefinedIndicates if the domain is using HTTP.
localesstring[] | undefinedAn array of available locales.
localestring | undefinedThe currently active locale.
urlURLThe URL object.
PropertyTypeDescription
basePathstringThe base path of the URL.
buildIdstring | undefinedThe build identifier of the Next.js application. Can be customized.
pathnamestringThe pathname of the URL.
searchParamsObjectThe search parameters of the URL.

Note: The internationalization properties from the Pages Router are not available for usage in the App Router. Learn more about internationalization with the App Router.

ip​

The ip property is a string that contains the IP address of the request. This value can optionally be provided by your hosting platform.

Good to know: On Vercel, this value is provided by default. On other platforms, you can use the X-Forwarded-For header to provide the IP address.

// Provided by Vercel
request.ip
// Self-hosting
request.headers.get('X-Forwarded-For')

geo​

The geo property is an object that contains the geographic information of the request. This value can optionally be provided by your hosting platform.

Good to know: On Vercel, this value is provided by default. On other platforms, you can use the X-Forwarded-For header to provide the IP address, then use a third-party service to lookup the geographic information.

// Provided by Vercel
request.geo.city
request.geo.country
request.geo.region
request.geo.latitude
request.geo.longitude

// Self-hosting
function getGeo(request) {
let ip = request.headers.get('X-Forwarded-For')
// Use a third-party service to lookup the geographic information
}