Server-side Helpers

withClerkHandler()

The withClerkHandler() helper integrates Clerk authentication and authorization into your SvelteKit application through hooks.

It accepts an optional options object, though it is recommended to pass these options as environment variables.

import { withClerkHandler } from 'svelte-clerk/server';

export const handle = withClerkHandler();

clerkClient

The clerkClient helper returns an instance of the JavaScript Backend SDK.

The following example demonstrates how you can use the auth() local to get the user's ID, and then use the Backend SDK's getUser() method to get the Backend User object.

import { redirect } from '@sveltejs/kit';
import { clerkClient } from 'svelte-clerk/server';

export const load = async ({ locals }) => {
	// Use `auth()` local to get the user's ID
	const { userId } = locals.auth();

	// Protect the route by checking if the user is signed in
	if (!userId) {
		return redirect(307, '/sign-in');
	}

	// Use the Backend SDK's `getUser()` method to get the Backend User object
	const user = await clerkClient.users.getUser(userId);

	// Return the Backend User object
	return {
		user: JSON.parse(JSON.stringify(user))
	};
};

buildClerkProps()

The buildClerkProps() helper is used to inform the client-side helpers of the authentication state of the user. This function is used for SSR in the root server load function of your SvelteKit application.

import { buildClerkProps } from 'svelte-clerk/server';

export const load = async ({ locals }) => {
	return {
		...buildClerkProps(locals.auth())
	};
};