HTTP Headers

Request

You can access the headers of the HTTP request at:

pageContext.headers
pageContext.headersOriginal

pageContext.headers is a string object (Record<string, string>) normalized by Vike, and pageContext.headersOriginal is the original object (unknown) provided by your server.

For example:

// pageContext.headers
{
  'accept-encoding': 'gzip, br',
  'accept-language': 'en-US,en;q=0.9,fr;q=0.8',
  'cache-control': 'max-age=0',
  connection: 'Keep-Alive',
  cookie: 'username=brillout; admin=true'
}
 
// pageContext.headersOriginal
[
  ['Accept-Encoding', 'gzip, br'],
  ['Accept-Language', 'en-US,en;q=0.9,fr;q=0.8']
  ['Cache-Control', 'max-age=0'],
  ['Connection', 'Keep-Alive'],
  ['Cookie', 'username=brillout; admin=true']
]

You can convert it to a standard Headers object by using new Headers():

const headers = new Headers(pageContext.headers)

All values are merged. You can get the list of values as an array (string[]):

const acceptLanguage = pageContext.headers['accept-language'].split(',').map((v) => v.trimStart())

For getting the list of cookie values, you can use a cookie parser (e.g. cookie-parser).

When using vike(app), both pageContext.headers and pageContext.headersOriginal are automatically set.

If you use renderPage(), you must define pageContext.headersOriginal yourself while Vike automatically sets pageContext.headers (derived from pageContext.headersOriginal).

import { renderPage } from 'vike/server'
 
app.get('*', async (req) => {
  const pageContextInit = {
    urlOriginal: req.url,
    // Define it here:
    headersOriginal: req.headers
  }
  const pageContext = await renderPage(pageContextInit)
  // ...
})

import { renderPage } from 'vike/server'
 
app.get('*', async (req: Request) => {
  const pageContextInit = {
    urlOriginal: req.url,
    // Define it here:
    headersOriginal: req.headers
  }
  const pageContext = await renderPage(pageContextInit)
  // ...
})

JavaScript

TypeScript

Response

See API > +headersResponse.

HTTP Headers

Request

Response

See also