tanstack-start-server-only
TanStack Start server-only patterns using createServerOnlyFn and cloudflare:workers env access. Use when: accessing Cloudflare environment variables (APP_URL, STRIPE_SECRET_KEY, etc.), creating server-only utility functions, working with Stripe or other server-only APIs, or when you need to ensure code only runs on the server and throws if called from client. Covers createServerOnlyFn vs createServerFn differences, env access patterns, and centralized server-only utilities.
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
TanStack Start Server-Only Patterns
Core Concepts
createServerOnlyFn vs createServerFn
-
createServerFn: Creates RPC functions callable from client, executes on server -
createServerOnlyFn: Creates functions that ONLY run on server, throws if called from client
Use createServerOnlyFn for:
- Utility functions that access
cloudflare:workersenv - Functions that should never be exposed to client code
- Shared server-side helpers (database access, external APIs)
Environment Variable Access
ALWAYS use env from cloudflare:workers for environment variables in wodsmith-start:
import {env} from 'cloudflare:workers'
// Access bindings and env vars
env.DB // D1 database
env.KV_SESSION // KV namespace
env.R2_BUCKET // R2 bucket
env.APP_URL // Environment variable
env.STRIPE_SECRET_KEY // Secret
NEVER use process.env - it doesn't work in Cloudflare Workers runtime.
TypeScript not recognizing env vars? If you've added new bindings in alchemy.run.ts and deployed with pnpm alchemy:dev, but TypeScript doesn't see them, run:
pnpm cf-typegen
This regenerates worker-configuration.d.ts from wrangler.jsonc to update the type definitions.
Patterns
Centralized Server-Only Utilities
Create shared utilities in src/lib/ using createServerOnlyFn:
// src/lib/env.ts
import {createServerOnlyFn} from '@tanstack/react-start'
import {env} from 'cloudflare:workers'
export const getAppUrl = createServerOnlyFn((): string => {
return env.APP_URL || 'https://wodsmith.com'
})
export const getStripeClientId = createServerOnlyFn((): string | undefined => {
return env.STRIPE_CLIENT_ID
})
Using Server-Only Functions
Import and call directly - no dynamic imports needed:
// In server-fns, route loaders, or other server code
import {getAppUrl} from '@/lib/env'
import {getStripe} from '@/lib/stripe'
export const myServerFn = createServerFn({method: 'POST'}).handler(async () => {
const appUrl = getAppUrl() // Safe - throws if called from client
const stripe = getStripe()
// ...
})
Server-Only API Clients
Wrap API clients in createServerOnlyFn:
// src/lib/stripe.ts
import {createServerOnlyFn} from '@tanstack/react-start'
import {env} from 'cloudflare:workers'
import Stripe from 'stripe'
let stripeInstance: Stripe | null = null
export const getStripe = createServerOnlyFn(() => {
if (stripeInstance) return stripeInstance
if (!env.STRIPE_SECRET_KEY) {
throw new Error('Missing STRIPE_SECRET_KEY')
}
stripeInstance = new Stripe(env.STRIPE_SECRET_KEY, {
apiVersion: '2025-02-24.acacia',
httpClient: Stripe.createFetchHttpClient(),
})
return stripeInstance
})
Server-Only Business Logic
Group related server-only functions:
// src/server/stripe-connect/accounts.ts
import {createServerOnlyFn} from '@tanstack/react-start'
import {getDb} from '@/db'
import {getAppUrl, getStripeClientId} from '@/lib/env'
import {getStripe} from '@/lib/stripe'
export const createExpressAccount = createServerOnlyFn(
async (teamId: string, email: string, teamName: string) => {
const db = getDb()
const stripe = getStripe()
const appUrl = getAppUrl()
// ... implementation
},
)
export const getOAuthAuthorizeUrl = createServerOnlyFn(
(teamId: string, teamSlug: string, userId: string, csrfToken: string) => {
const clientId = getStripeClientId()
const appUrl = getAppUrl()
// ... implementation
},
)
Import Rules
Safe Top-Level Imports
These can be imported at the top of any file:
-
@tanstack/react-start- Framework utilities includingcreateServerOnlyFn -
@/lib/env- Server-only env utilities (usescreateServerOnlyFn) -
@/lib/stripe- Server-only Stripe client (usescreateServerOnlyFn) -
@/server/*- Server-only business logic (usescreateServerOnlyFn) -
zod- Validation schemas -
@/db/schema- Schema type definitions
Why This Works
createServerOnlyFn is processed by a compiler plugin that:
- In server context: Returns the actual function
- In client context: Returns a function that throws an error
This means imports are safe - the function definition exists in both contexts, but execution is blocked on client.
File Organization
src/
├── lib/
│ ├── env.ts # Centralized env access (getAppUrl, getStripeClientId)
│ └── stripe.ts # Stripe client (getStripe)
├── server/
│ └── stripe-connect/
│ ├── accounts.ts # Server-only Stripe Connect functions
│ └── index.ts # Re-exports
└── server-fns/
└── *.ts # createServerFn RPCs that use server-only utilities
Common Mistakes
Wrong: Using process.env
// BAD - doesn't work in Cloudflare Workers
const appUrl = process.env.APP_URL
Wrong: Inline env access everywhere
// BAD - duplicated, no centralization
import {env} from 'cloudflare:workers'
const appUrl = env.APP_URL || 'https://wodsmith.com'
Right: Centralized server-only utilities
// GOOD - centralized, type-safe, server-only enforced
import {getAppUrl} from '@/lib/env'
const appUrl = getAppUrl()
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-02-03
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!