` storage driver.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
serverAssets: [
{
baseName: "templates",
dir: "./templates",
},
],
});
```
--------------------------------
### Nested Runtime Configuration
Source: https://nitro.build/docs/configuration
Demonstrates defining nested runtime configuration for database settings. Keys are mapped to environment variables using `NITRO_` prefix and `UPPER_SNAKE_CASE`.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
runtimeConfig: {
database: {
host: "localhost",
port: 5432,
},
},
});
```
--------------------------------
### Enable OpenAPI in Production
Source: https://nitro.build/docs/openapi
Enable OpenAPI endpoints in production environments using 'runtime' for dynamic generation or 'prerender' for static file serving.
```typescript
export default defineConfig({
openAPI: {
production: "runtime",
},
});
```
--------------------------------
### Custom Renderer Handler Example
Source: https://nitro.build/docs/renderer
A custom renderer handler function that receives an H3 event object and returns an HTML response. It programmatically generates the HTML content, including the current URL pathname.
```typescript
export default function renderer({ req }: { req: Request }) {
const url = new URL(req.url);
return new Response(
/* html */ `
Custom Renderer
Hello from custom renderer!
Current path: ${url.pathname}
`,
{ headers: { "content-type": "text/html; charset=utf-8" } }
);
}
```
--------------------------------
### Full Cache Options
Source: https://nitro.build/docs/routing
Configure detailed cache options, including `maxAge` and `swr`, for specific routes.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
routeRules: {
// Full cache options
'/api/data/**': {
cache: {
maxAge: 60,
swr: true,
// ...other cache options
},
},
}
});
```
--------------------------------
### Prepare SQL Statements
Source: https://nitro.build/docs/database
Prepare SQL statements for repeated execution using `db.prepare`. This can improve performance for frequently run queries.
```typescript
const db = useDatabase();
const stmt = db.prepare("SELECT * FROM users WHERE id = ?");
const result = await stmt.bind("1001").all();
```
--------------------------------
### Accessing Server Assets in Routes
Source: https://nitro.build/docs/storage
Demonstrates how to access and retrieve files from the 'assets/server' storage mount within a Nitro route handler.
```typescript
import { useStorage } from "nitro/storage";
export default defineHandler(async () => {
const serverAssets = useStorage("assets/server");
const keys = await serverAssets.getKeys();
const data = await serverAssets.getItem("data.json");
const template = await serverAssets.getItem("templates/welcome.html");
return { keys, data, template };
});
```
--------------------------------
### Local Development Environment Variables
Source: https://nitro.build/docs/configuration
Define runtime configuration variables in a .env file for local development. Restart the development server after creating or modifying the file.
```env
NITRO_API_TOKEN="123"
```
--------------------------------
### Custom Server Entry with Format Option
Source: https://nitro.build/docs/server-entry
Configuring a custom server entry with explicit `handler` and `format` options in `nitro.config.ts`. The `format` can be set to 'node' for Node.js style handlers.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
serverEntry: {
handler: "./server.ts",
format: "node" // "web" (default) or "node"
}
})
```
--------------------------------
### HPP Server Script Execution
Source: https://nitro.build/docs/renderer
Shows how to execute JavaScript on the server within an HPP template using the
{{ JSON.stringify(data) }}
```
--------------------------------
### Basic Nitro Configuration
Source: https://nitro.build/docs/configuration
This is the most basic Nitro configuration file. It uses `defineConfig` from 'nitro'.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
// Nitro options
})
```
--------------------------------
### Default In-Memory Storage
Source: https://nitro.build/docs/storage
Illustrates the default in-memory storage behavior, where data is not persisted across restarts. For persistence, a custom driver must be mounted.
```javascript
import { useStorage } from "nitro/storage";
// In-memory by default, not persisted
await useStorage().setItem("counter", 1);
```
--------------------------------
### Middleware Execution Order
Source: https://nitro.build/docs/routing
Middleware in the 'middleware/' directory are executed in alphabetical order by default. Prefixing filenames with numbers controls the order.
```bash
middleware/
auth.ts <-- First
logger.ts <-- Second
... <-- Third
```
```bash
middleware/
1.logger.ts <-- First
2.auth.ts <-- Second
3.... <-- Third
```
--------------------------------
### Extending Configurations
Source: https://nitro.build/docs/configuration
Shows how to extend Nitro configurations from other files or presets using the `extends` key. This allows for modular configuration management.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
extends: "./base.config",
})
```
--------------------------------
### Accessing Custom Asset Directories
Source: https://nitro.build/docs/storage
Demonstrates how to access custom asset directories registered via the Nitro configuration.
```typescript
import { useStorage } from "nitro/storage";
const templates = useStorage("assets/templates");
const keys = await templates.getKeys();
const html = await templates.getItem("email.html");
```
--------------------------------
### HPP Output Expressions
Source: https://nitro.build/docs/renderer
Demonstrates HTML-escaped and raw output expressions using the Hypertext Preprocessor (HPP).
```html
Hello {{ $URL.pathname }}
{{{ 'raw html' }}}
```
--------------------------------
### Mark Routes for Prerendering
Source: https://nitro.build/docs/routing
Mark specific routes to be prerendered at build time.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
routeRules: {
'/about': { prerender: true },
}
});
```
--------------------------------
### Client-side EventSource Connection
Source: https://nitro.build/docs/websocket
Demonstrates how to connect to an SSE endpoint from the client-side using the `EventSource` API and log incoming messages to the console.
```javascript
const source = new EventSource("/sse");
source.onmessage = (event) => {
console.log(event.data);
};
```
--------------------------------
### Enable SWR shortcut for route rules
Source: https://nitro.build/docs/cache
Utilize the 'swr' shortcut to enable stale-while-revalidate caching. 'true' uses default maxAge, while a number specifies the maxAge in seconds.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
routeRules: {
"/blog/**": { swr: true },
"/api/**": { swr: 3600 },
},
});
```
--------------------------------
### Proxy with Options
Source: https://nitro.build/docs/routing
Configure proxy requests with additional H3 proxy options for more advanced control.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
routeRules: {
// Proxy with options
'/external/**': {
proxy: {
to: 'https://api.example.com/**',
// Additional H3 proxy options...
},
},
}
});
```
--------------------------------
### Configure Database Connections
Source: https://nitro.build/docs/database
Define multiple database connections, including their connectors and options, in the `nitro.config.ts` file. Supports SQLite and PostgreSQL.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
database: {
default: {
connector: "sqlite",
options: { name: "db" }
},
users: {
connector: "postgresql",
options: {
url: "postgresql://username:password@hostname:port/database_name"
},
},
},
});
```
--------------------------------
### Environment Specific Route Files
Source: https://nitro.build/docs/routing
Specify routes that are only included in specific builds by adding .dev, .prod, or .prerender suffixes to route files.
```nitro
routes/
env/
index.dev.ts <-- /env (dev only)
index.get.prod.ts <-- /env (GET, prod only)
```
--------------------------------
### HPP Streaming Content
Source: https://nitro.build/docs/renderer
Demonstrates streaming content in HPP templates using the echo() function with various data types.
```html
```
--------------------------------
### Peer Subscribe Method
Source: https://nitro.build/docs/websocket
Use `peer.subscribe()` to add a peer to a specific pub/sub topic, enabling targeted message broadcasting.
```javascript
peer.subscribe("notifications");
```
--------------------------------
### Environment-Specific Configuration
Source: https://nitro.build/docs/configuration
Demonstrates environment-specific overrides for Nitro configuration using `$development` and `$production` keys. Options within these keys are applied only in their respective environments.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
logLevel: 3,
$development: {
// Options applied only in development mode
debug: true,
},
$production: {
// Options applied only in production builds
minify: true,
},
})
```
--------------------------------
### Directory Options Configuration
Source: https://nitro.build/docs/configuration
Configures various directory options for Nitro, including `serverDir`, `buildDir`, and `output` directories. These control the project's structure and build artifacts.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
serverDir: "server",
buildDir: "node_modules/.nitro",
output: {
dir: ".output",
},
})
```
--------------------------------
### Runtime Route Rules with Headers
Source: https://nitro.build/docs/routing
Define route rules dynamically using `runtimeConfig` to allow overrides via environment variables without rebuilding.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
runtimeConfig: {
nitro: {
routeRules: {
'/api/**': { headers: { 'x-env': 'production' } },
},
},
},
});
```
--------------------------------
### Enable All Compressed Public Assets
Source: https://nitro.build/docs/assets
Nitro configuration to enable automatic compression for public assets using gzip, brotli, and zstd.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
compressPublicAssets: true,
});
```
--------------------------------
### Bun Package Manager Hoisting Configuration
Source: https://nitro.build/docs/nightly
When using Bun in a monorepo, configure publicHoistPattern in bunfig.toml to ensure the nitro package is properly hoisted.
```toml
[install]
publicHoistPattern = ["nitro*"]
```
--------------------------------
### Custom Server Entry File Configuration
Source: https://nitro.build/docs/server-entry
Configuring Nitro to use a custom server entry file named `nitro.server.ts` by specifying the `serverEntry` option in `nitro.config.ts`.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
serverEntry: "./nitro.server.ts"
})
```
--------------------------------
### Configure ISR (Vercel)
Source: https://nitro.build/docs/routing
Configure Incremental Static Regeneration (ISR) for Vercel deployments.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
routeRules: {
'/isr/**': { isr: true },
}
});
```
--------------------------------
### Route Meta Definition with OpenAPI
Source: https://nitro.build/docs/routing
Define route handler meta at build-time using defineRouteMeta, currently usable for specifying OpenAPI meta.
```typescript
import { defineRouteMeta } from "nitro";
import { defineHandler } from "nitro";
defineRouteMeta({
openAPI: {
tags: ["test"],
description: "Test route description",
parameters: [{ in: "query", name: "test", required: true }],
},
});
export default defineHandler(() => "OK");
```
--------------------------------
### Configure OpenAPI UI Integrations
Source: https://nitro.build/docs/openapi
Configure or disable built-in API documentation UIs such as Scalar and Swagger, including their routes and themes.
```typescript
export default defineConfig({
openAPI: {
ui: {
scalar: {
route: "/_docs/scalar",
theme: "purple",
},
swagger: {
route: "/_docs/swagger",
},
},
},
});
```
--------------------------------
### Basic Server Entry with Fetch Handler
Source: https://nitro.build/docs/server-entry
A default `server.ts` file that handles a health check route and can be extended to add custom headers or modify requests before they proceed to route matching.
```typescript
export default {
async fetch(req: Request) {
const url = new URL(req.url);
// Handle specific routes
if (url.pathname === "/health") {
return new Response("OK", {
status: 200,
headers: { "content-type": "text/plain" }
});
}
// Add custom headers to all requests
// Return nothing to continue to the next handler
}
}
```
--------------------------------
### Environment Variable Expansion in Runtime Config
Source: https://nitro.build/docs/configuration
Enable experimental environment variable expansion to allow `{{VAR_NAME}}` syntax in runtime config string values. These variables are expanded at runtime.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
experimental: {
envExpansion: true,
},
runtimeConfig: {
url: "https://{{APP_DOMAIN}}/api",
},
});
```
```env
APP_DOMAIN="example.com"
```
--------------------------------
### Migrate Headers Handling
Source: https://nitro.build/docs/migration
Switch from h3 header utilities to standard Web `Headers` API for accessing and setting request and response headers. Header values are always strings.
```typescript
-- import { getHeader, setHeader, getResponseStatus } from "nitro/h3"
-- getHeader(event, "x-foo")
-- setHeader(event, "x-foo", "bar")
++ event.req.headers.get("x-foo")
++ event.res.headers.set("x-foo", "bar")
++ event.res.status // instead of getResponseStatus(event)
```
--------------------------------
### Public Assets Directory Structure
Source: https://nitro.build/docs/assets
Illustrates how files in the public directory are served directly by Nitro.
```text
public/
image.png <-- /image.png
video.mp4 <-- /video.mp4
robots.txt <-- /robots.txt
```
--------------------------------
### Enable Database Feature
Source: https://nitro.build/docs/database
Enable the experimental database feature in Nitro's configuration.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
experimental: {
database: true
}
})
```
--------------------------------
### Simple Redirect
Source: https://nitro.build/docs/routing
Use a string for a simple redirect, which defaults to a 307 status code.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
routeRules: {
// Simple redirect (307 status)
'/old-page': { redirect: '/new-page' },
}
});
```
--------------------------------
### Configure Nitro Server Directory
Source: https://nitro.build/docs/quick-start
Specify the server directory for Nitro routes by creating a nitro.config.ts file with the serverDir option.
```typescript
import {
defineConfig
} from "nitro";
export default defineConfig({
serverDir: "./server",
});
```
--------------------------------
### Cache all blog routes for 1 hour with stale-while-revalidate
Source: https://nitro.build/docs/cache
Configure route rules to cache all routes under '/blog/**' for 1 hour using stale-while-revalidate behavior.
```typescript
import { defineConfig } from "nitro";
export default defineConfig({
routeRules: {
"/blog/**": { cache: { maxAge: 60 * 60 } },
},
});
```