19 KiB
| id | title |
|---|---|
| server-functions | Server Functions |
What are Server Functions?
Server functions allow you to specify specific function to run only on the server. They are used to perform tasks that should never be directly exposed to the client.
How do they work?
Server functions can be defined anywhere in your application, but must be defined at the top level of a file. They can be called from anywhere in your application, including loaders, hooks, etc. Traditionally, this pattern is known as a Remote Procedure Call (RPC), but due to the isomorphic nature of these functions, we refer to them as server functions.
- On the server bundle, server functions are left alone. Nothing needs to be done since they are already in the correct place.
- On the client however, server functions are removed out of the client bundle and replaced with a function that, when called, makes a
fetchrequest to the server instructing it to execute the server function in the server bundle and then send the response back to the client.
Defining Server Functions
Server functions are defined using the createServerFn function, exported from the @tanstack/start package. This function must be called with an HTTP verb, and an async function that will be executed on the server. Here's an example:
// getServerTime.ts
import { createServerFn } from '@tanstack/start'
export const getServerTime = createServerFn('GET', async () => {
// Wait for 1 second
await new Promise((resolve) => setTimeout(resolve, 1000))
// Return the current time
return new Date().toISOString()
})
Where can I call server functions?
- From server-side code
- From client-side code
- From other server functions
- Anywhere, really!
Accepting Parameters
Server functions accept a single parameter, which can be a variety of types:
- Primitives
stringnumberbooleannullArrayObject
- FormData
- ReadableStream (of any of the above)
- Promise (of any of the above)
Here's an example of a server function that accepts a simple string parameter:
import { createServerFn } from '@tanstack/start'
export const greet = createServerFn('GET', async (name: string) => {
return `Hello, ${name}!`
})
Type Safety
Server functions are fully typed, and the type of the parameter is inferred from the function signature:
import { createServerFn } from '@tanstack/start'
type Person = {
name: string
}
export const greet = createServerFn('GET', async (person: Person) => {
return `Hello, ${person.name}!`
})
function test() {
greet({ name: 'John' }) // OK
greet({ name: 123 }) // Error: Argument of type '{ name: number; }' is not assignable to parameter of type 'Person'.
}
JSON Parameters
Server functions can accept JSON-serializable objects as parameters. This is useful for passing complex data structures to the server:
import { createServerFn } from '@tanstack/start'
type Person = {
name: string
age: number
}
export const greet = createServerFn('GET', async (person: Person) => {
return `Hello, ${person.name}! You are ${person.age} years old.`
})
FormData Parameters
Server functions can accept FormData objects as parameters
import { createServerFn } from '@tanstack/start'
export const greetUser = createServerFn('POST', async (formData: FormData) => {
const name = formData.get('name')
const age = formData.get('age')
return `Hello, ${name}! You are ${age} years old.`
})
// Usage
function Test() {
return (
<form
onSubmit={async (event) => {
event.preventDefault()
const formData = new FormData(event.target)
const response = await greetUser(formData)
console.log(response)
}}
>
<input name="name" />
<input name="age" />
<button type="submit">Submit</button>
</form>
)
}
Server Function Context
In addition to the single parameter that server functions accept, you can also access server request context from within any server function using many utilities from vinxi/http. Under the hood, Vinxi uses unjs's h3 package to perform cross-platform HTTP requests.
There are many context functions available to you for things like:
- Accessing the request context
- Accessing/setting headers
- Accessing/setting sessions/cookies
- Setting response status codes and status messages
- Dealing with multi-part form data
- Reading/Setting custom server context properties
For a full list of available context functions, see all of the available h3 Methods or inspect the Vinxi Exports Source Code.
For starters, here are a few examples:
Accessing the Request Context
Let's use Vinxi's getWebRequest function to access the request itself from within a server function:
import { createServerFn } from '@tanstack/start'
import { getWebRequest } from 'vinxi/http'
export const getServerTime = createServerFn('GET', async () => {
const request = getWebRequest()
console.log(request.method) // GET
console.log(request.headers.get('User-Agent')) // Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3
})
Accessing Headers
Use Vinxi's getHeaders function to access all headers from within a server function:
import { createServerFn } from '@tanstack/start'
import { getHeaders } from 'vinxi/http'
export const getServerTime = createServerFn('GET', async () => {
console.log(getHeaders())
// {
// "accept": "*/*",
// "accept-encoding": "gzip, deflate, br",
// "accept-language": "en-US,en;q=0.9",
// "connection": "keep-alive",
// "host": "localhost:3000",
// ...
// }
})
You can also access individual headers using the getHeader function:
import { createServerFn } from '@tanstack/start'
import { getHeader } from 'vinxi/http'
export const getServerTime = createServerFn('GET', async () => {
console.log(getHeader('User-Agent')) // Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3
})
Returning Values
Server functions can return a few different types of values:
- Primitives
- JSON-serializable objects
redirecterrors (can also be thrown)notFounderrors (can also be thrown)- Raw Response objects
Returning Primitives and JSON
To return any primitive or JSON-serializable object, simply return the value from the server function:
import { createServerFn } from '@tanstack/start'
export const getServerTime = createServerFn('GET', async () => {
return new Date().toISOString()
})
export const getServerData = createServerFn('GET', async () => {
return {
message: 'Hello, World!',
}
})
By default, server functions assume that any non-Response object returned is either a primitive or JSON-serializable object.
Responding with Custom Headers
To respond with custom headers, you can use Vinxi's setHeader function:
import { createServerFn } from '@tanstack/start'
import { setHeader } from 'vinxi/http'
export const getServerTime = createServerFn('GET', async () => {
setHeader('X-Custom-Header', 'value')
return new Date().toISOString()
})
Responding with Custom Status Codes
To respond with a custom status code, you can use Vinxi's setResponseStatus function:
import { createServerFn } from '@tanstack/start'
import { setResponseStatus } from 'vinxi/http'
export const getServerTime = createServerFn('GET', async () => {
setResponseStatus(201)
return new Date().toISOString()
})
Returning Raw Response objects
To return a raw Response object, simply return a Response object from the server function:
import { createServerFn } from '@tanstack/start'
export const getServerTime = createServerFn('GET', async () => {
// Read a file from s3
return fetch('https://example.com/time.txt')
})
Throwing Errors
Aside from special redirect and notFound errors, server functions can throw any custom error. These errors will be serialized and sent to the client as a JSON response along with a 500 status code.
import { createServerFn } from '@tanstack/start'
export const doStuff = createServerFn('GET', async () => {
throw new Error('Something went wrong!')
})
// Usage
function Test() {
try {
await doStuff()
} catch (error) {
console.error(error)
// {
// message: "Something went wrong!",
// stack: "Error: Something went wrong!\n at doStuff (file:///path/to/file.ts:3:3)"
// }
}
}
Calling server functions from within route lifecycles
Server functions can be called normally from route loaders, beforeLoads, or any other router-controlled APIs. These APIs are equipped to handle errors, redirects, and notFounds thrown by server functions automatically.
import { getServerTime } from './getServerTime'
export const Route = createFileRoute('/time')({
loader: async () => {
const time = await getServerTime()
return {
time,
}
},
})
Calling server functions from hooks and components
Server functions can throw redirects or notFounds and while not required, it is recommended to catch these errors and handle them appropriately. To make this easier, the @tanstack/start package exports a useServerFn hook that can be used to bind server functions to components and hooks:
import { useServerFn } from '@tanstack/start'
import { useQuery } from '@tanstack/react-query'
import { getServerTime } from './getServerTime'
export function Time() {
const getTime = useServerFn(getServerTime)
const timeQuery = useQuery({
queryKey: 'time',
queryFn: () => getTime(),
})
}
Calling server functions anywhere else
Server functions are just async functions, so they can ultimately be called from anywhere in your application. However, be aware that any redirects or notFounds thrown by server functions will not be handled automatically unless called from a route lifecycle or a component that uses the useServerFn hook.
Redirects
Server functions can throw a redirect error to redirect the user to a different URL. This is useful for handling authentication, authorization, or other scenarios where you need to redirect the user to a different page.
- During SSR, redirects are handled by sending a 302 response to the client with the new location
- On the client, redirects are handled by the router automatically from within a route lifecycle or a component that uses the
useServerFnhook. If you call a server function from anywhere else, redirects will not be handled automatically.
To throw a redirect, you can use the redirect function exported from the @tanstack/react-router package:
import { redirect } from '@tanstack/react-router'
import { createServerFn } from '@tanstack/start'
export const doStuff = createServerFn('GET', async () => {
// Redirect the user to the home page
throw redirect({
to: '/',
})
})
Redirects can utilize all of the same options as router.navigate, useNavigate() and <Link> components. So feel free to also pass:
- Path Params
- Search Params
- Hash
Redirects can also set the status code of the response by passing a status option:
import { redirect } from '@tanstack/react-router'
import { createServerFn } from '@tanstack/start'
export const doStuff = createServerFn('GET', async () => {
// Redirect the user to the home page with a 301 status code
throw redirect({
to: '/',
status: 301,
})
})
⚠️ Do not use Vinxi's
sendRedirectfunction to send soft redirects from within server functions. This will send the redirect using theLocationheader and will force a full page hard navigation on the client.
Redirect Headers
You can also set custom headers on a redirect by passing a headers option:
import { redirect } from '@tanstack/react-router'
import { createServerFn } from '@tanstack/start'
export const doStuff = createServerFn('GET', async () => {
// Redirect the user to the home page with a custom header
throw redirect({
to: '/',
headers: {
'X-Custom-Header': 'value',
},
})
})
Not Found
While calling a server function from a loader or beforeLoad route lifecycle, a special notFound error can be thrown to indicate to the router that the requested resource was not found. This is more useful than a simple 404 status code, as it allows you to render a custom 404 page, or handle the error in a custom way. If notFound is thrown from a server function used outside of a route lifecycle, it will not be handled automatically.
To throw a notFound, you can use the notFound function exported from the @tanstack/start package:
import { createServerFn, notFound } from '@tanstack/start'
const getStuff = createServerFn('GET', async () => {
// Randomly return a not found error
if (Math.random() < 0.5) {
throw notFound()
}
// Or return some stuff
return {
stuff: 'stuff',
}
})
export const Route = createFileRoute('/stuff')({
loader: async () => {
const stuff = await getStuff()
return {
stuff,
}
},
})
Not found errors are a core feature of TanStack Router,
Handling Errors
If a server function throws a (non-redirect/non-notFound) error, it will be serialized and sent to the client as a JSON response along with a 500 status code. This is useful for debugging, but you may want to handle these errors in a more user-friendly way. You can do this by catching the error and handling it in your route lifecycle, component, or hook as you normally would.
import { createServerFn } from '@tanstack/start'
export const doStuff = createServerFn('GET', async () => {
undefined.foo()
})
export const Route = createFileRoute('/stuff')({
loader: async () => {
try {
await doStuff()
} catch (error) {
// Handle the error:
// error === {
// message: "Cannot read property 'foo' of undefined",
// stack: "TypeError: Cannot read property 'foo' of undefined\n at doStuff (file:///path/to/file.ts:3:3)"
}
},
})
No-JS Server Functions
Without JavaScript enabled, there's only one way to execute server functions: by submitting a form.
This is done by adding a form element to the page
with the HTML attribute action.
Notice that we mentioned the HTML attribute
action. This attribute only accepts a string in HTML, just like all other attributes.While React 19 added support for passing a function to
action, it's a React-specific feature and not part of the HTML standard.
The action attribute tells the browser where to send the form data when the form is submitted. In this case, we want
to send the form data to the server function.
To do this, we can utilize the url property of the server function:
const yourFn = createServerFn('POST', async () => {
// Server-side code lives here
})
console.info(yourFn.url)
And pass this to the action attribute of the form:
function Component() {
return (
<form action={yourFn.url} method="POST">
<button type="submit">Click me!</button>
</form>
)
}
When the form is submitted, the server function will be executed.
No-JS Server Function Arguments
To pass arguments to a server function when submitting a form, you can use the input element with the name attribute
to attach the argument to the FormData passed to your
server function:
const yourFn = createServerFn('POST', async (formData: FormData) => {
// `val` will be '123'
const val = formData.get('val')
// ...
})
function Component() {
return (
// We need to tell the server that our data type is `multipart/form-data` by setting the `encType` attribute on the form.
<form action={yourFn.url} method="POST" encType="multipart/form-data">
<input name="val" defaultValue="123" />
<button type="submit">Click me!</button>
</form>
)
}
When the form is submitted, the server function will be executed with the form's data as an argument.
No-JS Server Function Return Value
Regardless of whether JavaScript is enabled, the server function will return a response to the HTTP request made from the client.
When JavaScript is enabled, this response can be accessed as the return value of the server function in the client's JavaScript code.
const yourFn = createServerFn('POST', async () => {
return 'Hello, world!'
})
// `.then` is not available when JavaScript is disabled
yourFn().then(console.log)
However, when JavaScript is disabled, there is no way to access the return value of the server function in the client's JavaScript code.
Instead, the server function can provide a response to the client, telling the browser to navigate in a certain way.
When combined with a loader from TanStack Router, we're able to provide an experience similar to a single-page application, even when
JavaScript is disabled;
all by telling the browser to reload the current page with new data piped through the loader:
import * as fs from 'fs'
import { createFileRoute } from '@tanstack/react-router'
import { createServerFn } from '@tanstack/start'
const filePath = 'count.txt'
async function readCount() {
return parseInt(
await fs.promises.readFile(filePath, 'utf-8').catch(() => '0'),
)
}
const getCount = createServerFn('GET', () => {
return readCount()
})
const updateCount = createServerFn('POST', async (formData: FormData) => {
const count = await readCount()
const addBy = Number(formData.get('addBy'))
await fs.promises.writeFile(filePath, `${count + addBy}`)
// Reload the page to trigger the loader again
return new Response('ok', { status: 301, headers: { Location: '/' } })
})
export const Route = createFileRoute('/')({
component: Home,
loader: async () => await getCount(),
})
function Home() {
const state = Route.useLoaderData()
return (
<div>
<form
action={updateCount.url}
method="POST"
encType="multipart/form-data"
>
<input type="number" name="addBy" defaultValue="1" />
<button type="submit">Add</button>
</form>
<pre>{state}</pre>
</div>
)
}
How are server functions compiled?
Under the hood, server functions are extracted out of the client bundle and into a separate server bundle. On the server, they are executed as-is, and the result is sent back to the client. On the client, server functions proxy the request to the server, which executes the function and sends the result back to the client, all via fetch.
The process looks like this:
- When
createServerFnis found in a file, the inner function is checked for ause serverdirective - If the
use serverdirective is missing, it is added to the top of the function - On the client, the inner function is extracted out of the client bundle and into a separate server bundle
- The client-side server function is replaced with a proxy function that sends a request to the server to execute the function that was extracted
- On the server, the server function is no extracted and is executed as-is
- After extraction occurs, each bundle applies a dead-code elimination process to remove any unused code from each bundle.