Skip to content

docs: fixed example of env variable validation with zod #5584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+32 −22
Open

docs: fixed example of env variable validation with zod #5584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aa92816
docs: fixed example of env variable validation with zod
max-programming Oct 22, 2025
13ceb18
ci: apply automated fixes
autofix-ci[bot] Oct 22, 2025
2142ece
Directly use `z.url()` instead of `z.string().url()`
max-programming Oct 22, 2025
de0aabe
docs: fix wrong package name in import in solid docs
max-programming Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions docs/start/framework/react/guide/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,26 +278,31 @@ Use Zod for runtime validation of environment variables:

```typescript
// src/config/env.ts
import { createIsomorphicFn } from '@tanstack/react-start'
import { z } from 'zod'

const envSchema = z.object({
DATABASE_URL: z.string().url(),
JWT_SECRET: z.string().min(32),
NODE_ENV: z.enum(['development', 'production', 'test']),
})

const clientEnvSchema = z.object({
VITE_APP_NAME: z.string(),
VITE_API_URL: z.string().url(),
VITE_API_URL: z.url(),
VITE_AUTH0_DOMAIN: z.string(),
VITE_AUTH0_CLIENT_ID: z.string(),
})

// Validate server environment
export const serverEnv = envSchema.parse(process.env)
const serverEnvSchema = z
.object({
DATABASE_URL: z.url(),
JWT_SECRET: z.string().min(32),
NODE_ENV: z.enum(['development', 'production', 'test']),
})
.and(clientEnvSchema)

const getEnv = createIsomorphicFn()
.server(() => serverEnvSchema.parse(process.env))
.client(() => clientEnvSchema.parse(import.meta.env))

type Env = z.infer<typeof serverEnvSchema>

// Validate client environment
export const clientEnv = clientEnvSchema.parse(import.meta.env)
export const env = getEnv() as Env
```

## Security Best Practices
Expand Down
27 changes: 16 additions & 11 deletions docs/start/framework/solid/guide/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,26 +278,31 @@ Use Zod for runtime validation of environment variables:

```typescript
// src/config/env.ts
import { createIsomorphicFn } from '@tanstack/solid-start'
import { z } from 'zod'

const envSchema = z.object({
DATABASE_URL: z.string().url(),
JWT_SECRET: z.string().min(32),
NODE_ENV: z.enum(['development', 'production', 'test']),
})

const clientEnvSchema = z.object({
VITE_APP_NAME: z.string(),
VITE_API_URL: z.string().url(),
VITE_API_URL: z.url(),
VITE_AUTH0_DOMAIN: z.string(),
VITE_AUTH0_CLIENT_ID: z.string(),
})

// Validate server environment
export const serverEnv = envSchema.parse(process.env)
const serverEnvSchema = z
.object({
DATABASE_URL: z.url(),
JWT_SECRET: z.string().min(32),
NODE_ENV: z.enum(['development', 'production', 'test']),
})
.and(clientEnvSchema)

const getEnv = createIsomorphicFn()
.server(() => serverEnvSchema.parse(process.env))
.client(() => clientEnvSchema.parse(import.meta.env))

type Env = z.infer<typeof serverEnvSchema>

// Validate client environment
export const clientEnv = clientEnvSchema.parse(import.meta.env)
export const env = getEnv() as Env
```

## Security Best Practices
Expand Down
Loading