Nuxt/docs/3.api/2.composables/use-request-event.md
Sébastien Chopin f26a801775
docs: update to new website (#23743)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Daniel Roe <daniel@roe.dev>
2023-10-18 12:59:43 +02:00

24 lines
570 B
Markdown

---
title: 'useRequestEvent'
description: 'Access the incoming request event with the useRequestEvent composable.'
links:
- label: Source
icon: i-simple-icons-github
to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/ssr.ts
size: xs
---
Within your pages, components, and plugins you can use `useRequestEvent` to access the incoming request.
```ts
// Get underlying request event
const event = useRequestEvent()
// Get the URL
const url = event.path
```
::callout
In the browser, `useRequestEvent` will return `undefined`.
::