getCookie()
Reads a cookie value from the incoming request in a server handler.
Syntax
const value = getCookie(event, name) Parameters
| Name | Type | Required | Description |
|---|---|---|---|
event | H3Event | Yes | The request event. |
name | string | Yes | Cookie name to read. |
Returns
string | undefined — The cookie value, or undefined if absent.
Examples
// server/api/me.get.ts
export default defineEventHandler((event) => {
const token = getCookie(event, 'token')
if (!token) {
throw createError({ statusCode: 401, statusMessage: 'Unauthorized' })
}
return verify(token)
})
export default defineEventHandler((event) => {
const theme = getCookie(event, 'theme') ?? 'light'
return { theme }
})
Notes
Reads from the request `Cookie` header. Pair with `setCookie` to
write. For session validation, prefer `httpOnly` cookies set with
`secure` and `sameSite`. Returns `undefined` when the cookie is not
present.