`getRouterParam()`

Reads a dynamic route parameter from a server route file.

Since Nuxt 3.0 Spec ↗

Syntax

const value = getRouterParam(event, name)

Parameters

Name	Type	Required	Description
`event`	`H3Event`	Yes	The request event.
`name`	`string`	Yes	The dynamic segment name from the filename (e.g. `id`).

Returns

string | undefined — The matched parameter value.

Examples

// server/api/users/[id].get.ts -> /api/users/42
export default defineEventHandler((event) => {
  const id = getRouterParam(event, 'id')
  return db.users.find(id)
})

// server/api/[...slug].ts -> catch-all
export default defineEventHandler((event) => {
  const slug = getRouterParam(event, 'slug')
  return { path: slug }
})

Notes

Parameter names come from the bracketed filename segments (`[id]`, `[...slug]`). Returns `undefined` if absent. Decode/validate the value before use; for query string values use `getQuery`. Use `getRouterParams(event)` to get all params at once.