fix(docs): Complete server function mutation example and fix broken links. #3992

mpiroc · 2025-04-14T15:54:40Z

Fixes the following in the "learn the basics" doc for Tanstack Start:

The example snippet for server function mutations is incomplete and does not do what the description says it does.
The link to the full mutation docs was a broken, non-relative link.
Another link in this doc was also broken and non-relative.

I'm just getting started with Tanstack Start, so my example might not contain best practices--I would like feedback before merging!

Context (from discord):

Hi, I'm looking at https://tanstack.com/start/latest/docs/framework/react/learn-the-basics, and the example in the "Mutations" section seems to be missing a lot:

Missing import: z

Missing definition/import: db

Missing definition/import: users

It also doesn't seem to do what the description says:

Here's a quick example of how you can use server functions to perform a mutation on the server and invalidate the data on the client:
Unless I'm missing something, the example doesn't do any type of invalidation.

For context, here is the example:
import { createServerFn } from '@tanstack/react-start'

const UserSchema = z.object({
  id: z.string(),
  name: z.string(),
})

const updateUser = createServerFn({ method: 'POST' })
  .validator(UserSchema)
  .handler(async ({ data }) => {
    return db
      .update(users)
      .set({ name: data.name })
      .where(eq(users.id, data.id))
  })

// Somewhere else in your application
await updateUser({ data: { id: '1', name: 'John' } })

nx-cloud · 2025-04-14T17:54:44Z

View your CI Pipeline Execution ↗ for commit 70ff2ff.

Command	Status	Duration	Result
`nx affected --targets=test:eslint,test:unit,tes...`	✅ Succeeded	<1s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	1s	View ↗

☁️ Nx Cloud last updated this comment at 2025-04-17 08:11:41 UTC

docs/start/framework/react/learn-the-basics.md

pkg-pr-new · 2025-04-17T08:12:38Z

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@3992

@tanstack/create-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/create-router@3992

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@3992

@tanstack/create-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/create-start@3992

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@3992

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@3992

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@3992

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@3992

@tanstack/react-router-with-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-with-query@3992

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@3992

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@3992

@tanstack/react-start-config

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-config@3992

@tanstack/react-start-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-plugin@3992

@tanstack/react-start-router-manifest

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-router-manifest@3992

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@3992

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@3992

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@3992

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@3992

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@3992

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@3992

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@3992

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@3992

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@3992

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@3992

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@3992

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@3992

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@3992

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@3992

@tanstack/solid-start-config

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-config@3992

@tanstack/solid-start-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-plugin@3992

@tanstack/solid-start-router-manifest

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-router-manifest@3992

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@3992

@tanstack/start

npm i https://pkg.pr.new/TanStack/router/@tanstack/start@3992

@tanstack/start-api-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-api-routes@3992

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@3992

@tanstack/start-config

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-config@3992

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@3992

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-client@3992

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-fetcher@3992

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-handler@3992

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-server@3992

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-ssr@3992

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@3992

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@3992

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@3992

commit: 70ff2ff

Fix server function mutation example and broken links.

b03f028

github-actions bot added the documentation Everything documentation related label Apr 14, 2025

mpiroc added 2 commits April 14, 2025 11:58

Add missing export and import.

68c5715

Fix server function invocation.

4850ffb

schiller-manuel requested a review from SeanCassiere April 14, 2025 17:54

ci: apply automated fixes

8a06c47

SeanCassiere requested changes Apr 15, 2025

View reviewed changes

mpiroc and others added 2 commits April 16, 2025 12:48

Address PR feedback.

8a9ad9a

ci: apply automated fixes

ad8d85e

SeanCassiere requested changes Apr 16, 2025

View reviewed changes

docs/start/framework/react/learn-the-basics.md Outdated Show resolved Hide resolved

undo bring back $version/docs

70ff2ff

SeanCassiere approved these changes Apr 17, 2025

View reviewed changes

SeanCassiere merged commit d57f9f5 into TanStack:main Apr 17, 2025
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(docs): Complete server function mutation example and fix broken links. #3992

fix(docs): Complete server function mutation example and fix broken links. #3992

mpiroc commented Apr 14, 2025

nx-cloud bot commented Apr 14, 2025 •

edited

Loading

pkg-pr-new bot commented Apr 17, 2025

fix(docs): Complete server function mutation example and fix broken links. #3992

fix(docs): Complete server function mutation example and fix broken links. #3992

Conversation

mpiroc commented Apr 14, 2025

nx-cloud bot commented Apr 14, 2025 • edited Loading

pkg-pr-new bot commented Apr 17, 2025

nx-cloud bot commented Apr 14, 2025 •

edited

Loading