NextRequest

NextRequest extiende la API Web Request con métodos adicionales de conveniencia.

cookies

Lee o modifica el encabezado Set-Cookie de la solicitud.

set(nombre, valor)

Dado un nombre, establece una cookie con el valor proporcionado en la solicitud.

// Dada una solicitud entrante /home
// Establece una cookie para ocultar el banner
// la solicitud tendrá un encabezado `Set-Cookie:show-banner=false;path=/home`
request.cookies.set('show-banner', 'false')

get(nombre)

Dado un nombre de cookie, devuelve su valor. Si no se encuentra la cookie, devuelve undefined. Si hay múltiples cookies, devuelve la primera.

// Dada una solicitud entrante /home
// { name: 'show-banner', value: 'false', Path: '/home' }
request.cookies.get('show-banner')

getAll()

Dado un nombre de cookie, devuelve sus valores. Si no se proporciona nombre, devuelve todas las cookies de la solicitud.

// Dada una solicitud entrante /home
// [
//   { name: 'experiments', value: 'new-pricing-page', Path: '/home' },
//   { name: 'experiments', value: 'winter-launch', Path: '/home' },
// ]
request.cookies.getAll('experiments')
// Alternativamente, obtiene todas las cookies de la solicitud
request.cookies.getAll()

delete(nombre)

Dado un nombre de cookie, elimina la cookie de la solicitud.

// Devuelve true si se eliminó, false si no había nada que eliminar
request.cookies.delete('experiments')

has(nombre)

Dado un nombre de cookie, devuelve true si existe en la solicitud.

// Devuelve true si la cookie existe, false si no
request.cookies.has('experiments')

clear()

Elimina el encabezado Set-Cookie de la solicitud.

request.cookies.clear()

nextUrl

Extiende la API nativa URL con métodos adicionales de conveniencia, incluyendo propiedades específicas de Next.js.

// Dada una solicitud a /home, pathname es /home
request.nextUrl.pathname
// Dada una solicitud a /home?name=lee, searchParams es { 'name': 'lee' }
request.nextUrl.searchParams

Las siguientes opciones están disponibles:

PropiedadTipoDescripción
basePathstringLa ruta base de la URL.
buildIdstring | undefinedEl identificador de compilación de la aplicación Next.js. Puede personalizarse.
defaultLocalestring | undefinedLa configuración regional predeterminada para internacionalización.
domainLocale
- defaultLocalestringLa configuración regional predeterminada dentro de un dominio.
- domainstringEl dominio asociado a una configuración regional específica.
- httpboolean | undefinedIndica si el dominio usa HTTP.
localesstring[] | undefinedArray de configuraciones regionales disponibles.
localestring | undefinedLa configuración regional actualmente activa.
urlURLEl objeto URL.

Historial de versiones

VersiónCambios
v15.0.0Se eliminaron ip y geo.

On this page