getRequestEvent

getRequestEvent returns the current request event when one is available.

Import

import { getRequestEvent } from "solid-js/web";

Type

import type { RequestEvent } from "solid-js/web";

function getRequestEvent(): RequestEvent | undefined;

Return value

• Type: RequestEvent | undefined

Behavior

• getRequestEvent is for managed server/request scope.
• When available, the returned event includes the current Request as event.request.
• Depending on the server integration, the event can also expose request-scoped fields such as response, locals, or router state.
• If no current request event is available, including outside managed async scope, getRequestEvent returns undefined.

Examples

Basic usage

import { getRequestEvent } from "solid-js/web";

function readAuthorizationHeader() {
  const event = getRequestEvent();

  return event?.request.headers.get("Authorization") ?? null;
}

This example reads the event during request-scoped server execution.