headers
is an async function that allows you to read the HTTP incoming request headers from a Server Component.
import { headers } from 'next/headers'
export default async function Page() {
const headersList = await headers()
const userAgent = headersList.get('user-agent')
}
Reference Parameters
headers
does not take any parameters.
headers
returns a read-only Web Headers object.
Headers.entries()
: Returns an iterator
allowing to go through all key/value pairs contained in this object.Headers.forEach()
: Executes a provided function once for each key/value pair in this Headers
object.Headers.get()
: Returns a String
sequence of all the values of a header within a Headers
object with a given name.Headers.has()
: Returns a boolean stating whether a Headers
object contains a certain header.Headers.keys()
: Returns an iterator
allowing you to go through all keys of the key/value pairs contained in this object.Headers.values()
: Returns an iterator
allowing you to go through all values of the key/value pairs contained in this object.headers
is an asynchronous function that returns a promise. You must use async/await
or React's use
function.
headers
was a synchronous function. To help with backwards compatibility, you can still access it synchronously in Next.js 15, but this behavior will be deprecated in the future.headers
is read-only, you cannot set
or delete
the outgoing request headers.headers
is a Dynamic API whose returned values cannot be known ahead of time. Using it in will opt a route into dynamic rendering.import { headers } from 'next/headers'
export default async function Page() {
const authorization = (await headers()).get('authorization')
const res = await fetch('...', {
headers: { authorization }, // Forward the authorization header
})
const user = await res.json()
return <h1>{user.name}</h1>
}
Version History Version Changes v15.0.0-RC
headers
is now an async function. A codemod is available. v13.0.0
headers
introduced.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4