The RequestEvent object

Advanced SvelteKit / Hooks

Part 4/ Hooks/The RequestEvent object

The event object passed into handle is the same object — an instance of a RequestEvent — that is passed into API routes in +server.js files, form actions in +page.server.js files, and load functions in +page.server.js and +layout.server.js.

It contains a number of useful properties and methods, some of which we've already encountered:

• cookies — the cookies API
• fetch — the standard Fetch API, with additional powers
• getClientAddress() — a function to get the client's IP address
• isDataRequest — true if the browser is requesting data for a page during client-side navigation, false if a page/route is being requested directly
• locals — a place to put arbitrary data
• params — the route parameters
• request — the Request object
• route — an object with an id property representing the route that was matched
• setHeaders(...) — a function for setting HTTP headers on the response
• url — a URL object representing the current request

A useful pattern is to add some data to event.locals in handle so that it can be read in subsequent load functions:

export async function handle({ event, resolve }) {
	event.locals.answer = 42;
	return await resolve(event);
}

export function load(event) {
	return {
		message: `the answer is ${event.locals.answer}`
	};
}