From 775a904c7712de2541415c6c13692bce8d22f68e Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Thu, 9 Jun 2022 12:07:28 +0100 Subject: [PATCH] docs(api): add `useRequestEvent` (#5326) --- .../3.api/1.composables/use-request-event.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/content/3.api/1.composables/use-request-event.md diff --git a/docs/content/3.api/1.composables/use-request-event.md b/docs/content/3.api/1.composables/use-request-event.md new file mode 100644 index 0000000000..881dfc8801 --- /dev/null +++ b/docs/content/3.api/1.composables/use-request-event.md @@ -0,0 +1,17 @@ +# `useRequestEvent` + +Nuxt provides composables and utilities for first-class server-side-rendering support. + +Within your pages, components, and plugins you can use `useRequestEvent` to access the incoming request. + +```js +// Get underlying request event +const event = useRequestEvent() + +// Get the URL +const url = event.req.url +``` + +::alert{icon=👉} +In the browser, `useRequestEvent` will return `undefined`. +::