Returning Responses

In SolidStart it's possible to return a Response object from a server function. @solidjs/router knows how to handle certain responses with its cache and action APIs. For Typescript ergonomics, when returning a response using @solidjs/router's redirect, reload, or json helpers, they will not impact the return value of the server function.

You can always return or throw a response but we suggest that depending on the type of function to handle errors differently.

	cache	action
return	data, response	success message, error, response
throw	error, response	response

Examples

In the following example, as far as Typescript is concerned, the hello function will return a value of type Promise<{ hello: Promise<string> }>

tsx
import { json(alias) function json<T>(data: T, init?: RouterResponseInit): T
import json } from "@solidjs/router";
import { GET(alias) function GET<T extends (...args: any[]) => any>(fn: T): (...args: Parameters<T>) => ReturnType<T>
import GET } from "@solidjs/start";
 
const helloconst hello: (name: string) => Promise<{
    hello: Promise<string>;
}> = GET(alias) GET<(name: string) => Promise<{
    hello: Promise<string>;
}>>(fn: (name: string) => Promise<{
    hello: Promise<string>;
}>): (name: string) => Promise<{
    hello: Promise<string>;
}>
import GET(async (name(parameter) name: string: string) => {
  "use server";
  return json(alias) json<{
    hello: Promise<string>;
}>(data: {
    hello: Promise<string>;
}, init?: RouterResponseInit | undefined): {
    hello: Promise<string>;
}
import json(
    { hello(property) hello: Promise<string>: new PromiseCreates a new Promise.

var Promise: PromiseConstructor
new <string>(executor: (resolve: (value: string | PromiseLike<string>) => void, reject: (reason?: any) => void) => void) => Promise<string><string>(r(parameter) r: (value: string | PromiseLike<string>) => void => setTimeout[MDN Reference](https://developer.mozilla.org/docs/Web/API/setTimeout)

function setTimeout(handler: TimerHandler, timeout?: number | undefined, ...arguments: any[]): number(() => r(parameter) r: (value: string | PromiseLike<string>) => void(name(parameter) name: string), 1000)) },
    { headers(property) headers?: HeadersInit | undefined: { "cache-control": "max-age=60" } }
  );
});

tsx
import { json(alias) function json<T>(data: T, init?: RouterResponseInit): T
import json } from "@solidjs/router";
import { GET(alias) function GET<T extends (...args: any[]) => any>(fn: T): (...args: Parameters<T>) => ReturnType<T>
import GET } from "@solidjs/start";
 
const helloconst hello: (name: string) => Promise<{
    hello: Promise<string>;
}> = GET(alias) GET<(name: string) => Promise<{
    hello: Promise<string>;
}>>(fn: (name: string) => Promise<{
    hello: Promise<string>;
}>): (name: string) => Promise<{
    hello: Promise<string>;
}>
import GET(async (name(parameter) name: string: string) => {
  "use server";
  return json(alias) json<{
    hello: Promise<string>;
}>(data: {
    hello: Promise<string>;
}, init?: RouterResponseInit | undefined): {
    hello: Promise<string>;
}
import json(
    { hello(property) hello: Promise<string>: new PromiseCreates a new Promise.

var Promise: PromiseConstructor
new <string>(executor: (resolve: (value: string | PromiseLike<string>) => void, reject: (reason?: any) => void) => void) => Promise<string><string>(r(parameter) r: (value: string | PromiseLike<string>) => void => setTimeout[MDN Reference](https://developer.mozilla.org/docs/Web/API/setTimeout)

function setTimeout(handler: TimerHandler, timeout?: number | undefined, ...arguments: any[]): number(() => r(parameter) r: (value: string | PromiseLike<string>) => void(name(parameter) name: string), 1000)) },
    { headers(property) headers?: HeadersInit | undefined: { "cache-control": "max-age=60" } }
  );
});

In this next example, because redirect and reload return never that means the getUser function can only return a value of type Promise<User>

tsx
export async function getUser() {
  "use server"
  const session = await getSession();
  const userId = session.data.userId;
  if (userId === undefined) return redirect("/login");
  try {
    const user: User = await db.user.findUnique({ where: { id: userId } });
    // throwing here could have been a bit awkward.
    if (!user) return redirect("/login");
    return user;
  } catch {
    // do stuff
    throw redirect("/login");
  }
}

tsx
export async function getUser() {
  "use server"
  const session = await getSession();
  const userId = session.data.userId;
  if (userId === undefined) return redirect("/login");
  try {
    const user: User = await db.user.findUnique({ where: { id: userId } });
    // throwing here could have been a bit awkward.
    if (!user) return redirect("/login");
    return user;
  } catch {
    // do stuff
    throw redirect("/login");
  }
}