headers
API reference for the headers function.
headers is an async function that allows you to read the HTTP incoming request headers from a Server Component.
Reference
Parameters
headers does not take any parameters.
Returns
headers returns a read-only Web Headers object.
Headers.entries(): Returns aniteratorallowing to go through all key/value pairs contained in this object.Headers.forEach(): Executes a provided function once for each key/value pair in thisHeadersobject.Headers.get(): Returns aStringsequence of all the values of a header within aHeadersobject with a given name.Headers.has(): Returns a boolean stating whether aHeadersobject contains a certain header.Headers.keys(): Returns aniteratorallowing you to go through all keys of the key/value pairs contained in this object.Headers.values(): Returns aniteratorallowing you to go through all values of the key/value pairs contained in this object.
Good to know
headersis an asynchronous function that returns a promise. You must useasync/awaitor React'susefunction.- In version 14 and earlier,
headerswas 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.
- In version 14 and earlier,
- Since
headersis read-only, you cannotsetordeletethe outgoing request headers. headersis a Dynamic API whose returned values cannot be known ahead of time. Using it in will opt a route into dynamic rendering.
Examples
Using the Authorization header
Version History
| Version | Changes |
|---|---|
v15.0.0-RC | headers is now an async function. A codemod is available. |
v13.0.0 | headers introduced. |