Nitro

https://nitro.build/
Admin
Nitro is a full-stack server framework, compatible with any runtime and any deployment target. It...
Tokens:150,470
Snippets:1,510
Trust Score:8.6
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Local preview for Azure Static Web Apps

Source: https://nitro.build/deploy/providers/azure

Build and start a local preview environment for Azure Static Web Apps. Requires Azure Functions Core Tools installed. The first command builds with the azure_swa preset, the second starts the local preview using the Azure Static Web Apps CLI.

```bash
NITRO_PRESET=azure_swa npm run build
npx @azure/static-web-apps-cli start .output/public --api-location .output/server
```

--------------------------------

### Add start script to package.json

Source: https://nitro.build/deploy/providers/digitalocean

Add this start script to your package.json so DigitalOcean knows what command to run after a build.

```json
{
   "scripts": {
      "start": "node .output/server/index.mjs"
   }
}
```

--------------------------------

### nitro deploy examples

Source: https://nitro.build/docs/cli

Examples of deploying with the cloudflare_module preset and deploying an existing build without rebuilding.

```bash
# Build with the cloudflare_module preset, then run wrangler deploy
npx nitro deploy --preset cloudflare_module

# Deploy an existing build without rebuilding
npx nitro deploy --prebuilt
```

--------------------------------

### Example tracing output for GET /

Source: https://nitro.build/examples/tracing

Shows the console output of the tracing logger for a request to `/`. The header line shows the request, and rows show spans for middleware, route, and storage operations.

```text
▶ GET /  4.10ms  (4 spans)
  middleware GET /             █·······················   0.12ms h3.handler_type=middleware http.route=/
  GET /                        ·███████████████████·····   2.49ms h3.handler_type=route http.route=/
  getItem                      ···██····················   0.18ms db.operation=getItem db.system=memory unstorage.keys_count=1
  setItem                      ·····██··················   0.16ms db.operation=setItem db.system=memory unstorage.keys_count=1
```

--------------------------------

### Start Nitro production server with Bun

Source: https://nitro.build/deploy/runtimes/bun

Starts the Nitro production server built with the `bun` preset. Run this after building with the `bun` preset to enable Bun-specific optimizations.

```bash
bun run ./.output/server/index.mjs
```

--------------------------------

### Start the development server

Source: https://nitro.build/docs/quick-start

Run this command to start the Nitro development server. Your API route will be accessible at http://localhost:3000/api/test.

```bash
npm run dev
```

--------------------------------

### Build and preview example

Source: https://nitro.build/docs/cli

Builds the project and then previews the production build output.

```bash
npx nitro build
npx nitro preview
```

--------------------------------

### Zephyr deployment output example

Source: https://nitro.build/deploy/providers/zephyr

Example output after a successful build with deployOnBuild, showing the deployment URL printed by Nitro.

```text
◐ Building [Nitro] (preset: zephyr, compatibility: YYYY-MM-DD)
...
ZEPHYR   Uploaded local snapshot in 110ms
ZEPHYR   Deployed to Zephyr's edge in 700ms.
ZEPHYR
ZEPHYR   https://my-app.zephyrcloud.app
```

--------------------------------

### Create a new Nitro project with npx create-nitro-app

Source: https://nitro.build/blog/v3-beta

Run this command to scaffold a new Nitro project. It is the first step in the Getting Started guide.

```bash
npx create-nitro-app
```

--------------------------------

### Koyeb Run Command for Nitro

Source: https://nitro.build/deploy/providers/koyeb

Run command to start the Nitro server when no start command is defined in package.json. Enter this in the Run command field after toggling the override switch in the Koyeb control panel.

```bash
node .output/server/index.mjs
```

--------------------------------

### nitro build example with cloudflare preset

Source: https://nitro.build/docs/cli

Builds the project for the Cloudflare Module preset.

```bash
npx nitro build --preset cloudflare_module
```

--------------------------------

### Local preview with Wrangler

Source: https://nitro.build/deploy/providers/cloudflare

Builds the Nitro app and then starts a local preview using Wrangler.

```bash
npm run build
```

```bash
npx wrangler dev
```

--------------------------------

### Upsun deployment output

Source: https://nitro.build/deploy/providers/upsun

Example output from the Upsun pipeline when building and deploying the project.

```text
Building application 'nitro' (runtime type: nodejs:24)
  Executing build hook...
    W: + pnpm install
    W: + pnpm build
    [info] [nitro] Building Nitro Server (preset: `upsun`)
    [success] [nitro] Nitro Server built

Redeploying environment main
  Environment routes
    https://example.org/ is served by application `nitro`
```

--------------------------------

### nitro dev example with custom port and host

Source: https://nitro.build/docs/cli

Runs the dev server on port 4000 and host 0.0.0.0.

```bash
npx nitro dev --port 4000 --host 0.0.0.0
```

--------------------------------

### Deploy with Nitro CLI using zephyr preset

Source: https://nitro.build/deploy/providers/zephyr

Builds and uploads the app to Zephyr in one step. Nitro uploads the generated output using zephyr-agent; if missing, it prompts to install locally or installs automatically in CI.

```bash
npx nitro deploy --preset zephyr
```

--------------------------------

### Run task with payload example

Source: https://nitro.build/docs/cli

Runs the db:migrate task with a JSON payload. Requires the experimental.tasks flag and a running dev server.

```bash
npx nitro task run db:migrate --payload '{"force": true}'
```

--------------------------------

### Hook into build lifecycle with nitro.hooks.hook

Source: https://nitro.build/docs/modules

Shows how to use `nitro.hooks.hook()` to listen to the `compiled` hook and log the output directory. The `setup` function can be async.

```typescript
import type { NitroModule } from "nitro/types";

export default {
  name: "build-info",
  setup(nitro) {
    nitro.hooks.hook("compiled", () => {
      nitro.logger.info(`Server built in ${nitro.options.output.dir}`);
    });
  },
} satisfies NitroModule;
```

--------------------------------

### Basic Route: api/hello.ts

Source: https://nitro.build/examples/api-routes

Creates a GET /api/hello endpoint. Place this code in api/hello.ts.

```typescript
import { defineHandler } from "nitro";

export default defineHandler(() => "Nitro is amazing!");
```

--------------------------------

### Heroku CLI setup commands

Source: https://nitro.build/deploy/providers/heroku

Commands to create a Heroku app, set the Node.js buildpack, and configure the Nitro preset via environment variable.

```bash
heroku create myapp
```

```bash
heroku buildpacks:set heroku/nodejs
```

```bash
heroku config:set NITRO_PRESET=heroku
```

--------------------------------

### useDatabase with default and named connections

Source: https://nitro.build/docs/database

Shows how to get the default database instance and a named connection. Connections are created lazily and cached; an error is thrown if the name is not configured.

```typescript
import { useDatabase } from "nitro/database";

// Use the default connection
const db = useDatabase();

// Use a named connection
const usersDb = useDatabase("users");
```

--------------------------------

### nitro preview command

Source: https://nitro.build/docs/cli

Starts a local server to preview the production build output. Options: --dir for project root, --port for port, --host for hostname.

```bash
npx nitro preview [--dir <dir>] [--port <port>] [--host <host>]
```

--------------------------------

### nitro.config.ts with prerender options

Source: https://nitro.build/docs/prerendering

Example nitro.config.ts that configures prerendering options: crawlLinks, failOnError, concurrency, and autoSubfolderIndex. Use this as a starting point for customizing prerender behavior.

```typescript
import { defineConfig } from "nitro";

export default defineConfig({
  prerender: {
    crawlLinks: true,
    failOnError: true,
    concurrency: 8,
    autoSubfolderIndex: false,
  },
});
```

--------------------------------

### Register Nitro modules with path and function

Source: https://nitro.build/config

Register Nitro modules. Modules can be a string path, a module object with a setup function, or a function. This example includes a path and a function that hooks into the "compiled" event.

```javascript
export default defineConfig({
  modules: [
    "./modules/my-module.ts",
    (nitro) => {
      nitro.hooks.hook("compiled", () => { /* ... */ });
    },
  ],
});
```

--------------------------------

### Use useKV() for basic storage operations

Source: https://nitro.build/docs/storage

Shows how to access the default in-memory storage with useKV(), set and get items, use a base prefix, and apply generics for typed return values. The default storage is in-memory unless a driver is configured.

```javascript
import { useKV } from "nitro/kv";

// Default storage (in-memory)
await useKV().setItem("test:foo", { hello: "world" });
const value = await useKV().getItem("test:foo");

// You can specify a base prefix with useKV(base)
const testStorage = useKV("test");
await testStorage.setItem("foo", { hello: "world" });
await testStorage.getItem("foo"); // { hello: "world" }

// You can use generics to type the return value
await useKV<{ hello: string }>("test").getItem("foo");
await useKV("test").getItem<{ hello: string }>("foo");
```

--------------------------------

### Ignore routes with prerender.ignore in nitro.config.ts

Source: https://nitro.build/docs/prerendering

Skip routes from prerendering using the prerender.ignore array. Each entry can be a string prefix, a regular expression, or a function receiving the path. The example shows ignoring routes starting with /admin, ending with /preview, or containing "draft".

```typescript
import { defineConfig } from "nitro";

export default defineConfig({
  prerender: {
    crawlLinks: true,
    ignore: [
      "/admin",                        // Ignore routes starting with /admin
      /\/preview$/,                     // Ignore routes ending with /preview
      (path) => path.includes("draft"), // Ignore routes containing "draft"
    ],
  },
});
```

--------------------------------

### defineServerEntry with typed options

Source: https://nitro.build/docs/server-entry

Use defineServerEntry to get typed server options. The options are passed to the srvx server started by the Node.js, Bun, and Deno presets. Note that environment variables like NITRO_PORT/PORT take precedence over the port option, and other srvx options like middleware and plugins are ignored.

```typescript
import { defineServerEntry } from "nitro";

export default defineServerEntry({
  fetch(req) {
    return new Response("Hello from server entry!");
  },
  port: 8080,
  maxRequestBodySize: 1024 * 1024,
});
```

--------------------------------

### Example cache key

Source: https://nitro.build/docs/cache

Example cache key produced by the preceding defineCachedFunction example. The group nitro/functions is escaped to nitrofunctions.<hash> and the base /cache is normalized to cache:.

```text
cache:nitrofunctions.3aFYDY_G88ZLdElv-hEB0r8snSViMYJ1NbRtlNP9o_0:getAccessToken:default.json
```

--------------------------------

### Run dev server and send test requests

Source: https://nitro.build/examples/tracing

Start the development server and send requests to trigger tracing. Use `npm run dev` and then `curl` to the root and a dynamic route.

```bash
npm run dev
# then, in another terminal:
curl http://localhost:3000/
curl http://localhost:3000/users/42
```

--------------------------------

### GET Handler: api/test.get.ts

Source: https://nitro.build/examples/api-routes

GET handler for api/test.get.ts. Returns a plain string response.

```typescript
import { defineHandler } from "nitro";

export default defineHandler(() => "Test get handler");
```

--------------------------------

### Build and run Nitro with Deno preset

Source: https://nitro.build/deploy/runtimes/deno

Build the Nitro app using the Deno preset and start the production server with Deno, granting network, read, and environment permissions.

```bash
# Build with the Deno preset
NITRO_PRESET=deno_server npm run build

# Start production server
deno run --allow-net --allow-read --allow-env .output/server/index.mjs
```

--------------------------------

### Install nitro and vite

Source: https://nitro.build/docs/quick-start

Install Nitro and Vite as dependencies for adding Nitro to an existing Vite project.

```bash
npm i nitro vite
```

--------------------------------

### Create client entry with mount and StartClient

Source: https://nitro.build/examples/vite-ssr-solidstart

Client entry that hydrates the server-rendered HTML, attaching Solid's event handlers. Mounts StartClient to the #app element.

```tsx
// @refresh reload
import { mount, StartClient } from "@solidjs/start/client";

mount(() => <StartClient />, document.getElementById("app")!);
```

--------------------------------

### Specific request method route (GET)

Source: https://nitro.build/docs/routing

Route handler for a specific HTTP method (GET) by appending `.get` to the filename. Supported methods include get, post, put, delete, patch, head, options, query, connect, trace.

```typescript
// routes/users/[id].get.ts
import { defineHandler } from "nitro";

export default defineHandler(async (event) => {
  const { id } = event.context.params;

  // Do something with id

  return `User profile!`;
});
```

--------------------------------

### Create a runtime plugin with definePlugin

Source: https://nitro.build/docs/utils

Shows how to define a runtime plugin that runs once on server startup and hooks into the request lifecycle to log each request's pathname.

```typescript
import { definePlugin } from "nitro";

export default definePlugin((nitroApp) => {
  nitroApp.hooks.hook("request", (event) => {
    console.log("request:", event.url.pathname);
  });
});
```

--------------------------------

### Build and deploy with nitro/builder API

Source: https://nitro.build/docs/utils

Programmatically drive Nitro without the CLI. This example creates a Nitro instance, prepares, copies public assets, prerenders, builds, deploys, and closes the instance. The deploy command uses the preset's deploy configuration; presets without a deploy command throw an error.

```javascript
import { build, copyPublicAssets, createNitro, deploy, prepare, prerender } from "nitro/builder";

const nitro = await createNitro({ rootDir: ".", dev: false, preset: "cloudflare_module" });
await prepare(nitro);
await copyPublicAssets(nitro);
await prerender(nitro);
await build(nitro);
await deploy(nitro, { args: ["--env", "staging"] });
await nitro.close();
```

--------------------------------

### Configure Netlify preset with redirects

Source: https://nitro.build/config

Provide Netlify deploy configuration for the Netlify preset, including headers, redirects, functions, edge functions, and images. This example adds a redirect from `/old` to `/new` with status 301.

```javascript
export default defineConfig({
  netlify: {
    config: {
      redirects: [{ from: "/old", to: "/new", status: 301 }],
    },
  },
});
```

--------------------------------

### Enable tracing in nitro.config.ts (duplicate example)

Source: https://nitro.build/examples/tracing

Same configuration as the first example, but shown again in the 'Enabling tracing' section. It sets `tracingChannel: true` and `experimental.tracingLogger: true`.

```typescript
import { defineConfig } from "nitro";

export default defineConfig({
  // Instrument the h3, srvx and unstorage tracing channels.
  tracingChannel: true,

  experimental: {
    // Log every completed span to the console (built-in, dependency-free sink).
    tracingLogger: true,
  },
});
```

--------------------------------

### Install rolldown builder

Source: https://nitro.build/docs/migration

Install rolldown as a dev dependency to pin the builder version. Without it, nitro dev runs without a builder (builder: false).

```bash
npm i -D rolldown
```

--------------------------------

### Basic database usage with useDatabase and db.sql

Source: https://nitro.build/docs/database

Shows how to get the default database instance, create a table, insert a user, and query rows using tagged template literals.

```typescript
import { defineHandler } from "nitro";
import { useDatabase } from "nitro/database";

export default defineHandler(async () => {
  const db = useDatabase();

  // Create users table
  await db.sql`DROP TABLE IF EXISTS users`;
  await db.sql`CREATE TABLE IF NOT EXISTS users ("id" TEXT PRIMARY KEY, "firstName" TEXT, "lastName" TEXT, "email" TEXT)`;

  // Add a new user
  const userId = String(Math.round(Math.random() * 10_000));
  await db.sql`INSERT INTO users VALUES (${userId}, 'John', 'Doe', '')`;

  // Query for users
  const { rows } = await db.sql`SELECT * FROM users WHERE id = ${userId}`;

  return {
    rows,
  };
});
```

--------------------------------

### Configure Vite with Nitro and TanStack Start plugins

Source: https://nitro.build/examples/vite-ssr-tss-react

Configures Vite with Nitro, React, TanStack Start, and Tailwind plugins. The environments.ssr option points to the server entry file.

```javascript
import { defineConfig } from "vite";
import { nitro } from "nitro/vite";
import { tanstackStart } from "@tanstack/react-start/plugin/vite";
import viteReact from "@vitejs/plugin-react";
import tailwindcss from "@tailwindcss/vite";

export default defineConfig({
  plugins: [tanstackStart(), viteReact(), tailwindcss(), nitro()],
  resolve: { tsconfigPaths: true },
  environments: {
    ssr: { build: { rollupOptions: { input: "./server.ts" } } },
  },
});
```

--------------------------------

### Create server entry with createServerEntry

Source: https://nitro.build/examples/vite-ssr-tss-react

Creates the Nitro server entry for TanStack Start. The fetch method delegates to the TanStack Start handler, enabling SSR and API routes.

```typescript
import handler, { createServerEntry } from "@tanstack/react-start/server-entry";

export default createServerEntry({
  fetch(request) {
    return handler.fetch(request);
  },
});
```

--------------------------------

### Create a new Upsun project

Source: https://nitro.build/deploy/providers/upsun

Run this command to create a new project on Upsun.

```bash
upsun project:create
```

--------------------------------

### Public assets manifest example

Source: https://nitro.build/docs/assets

Example of the manifest metadata generated for public assets during production build. It includes type, etag, mtime, and size for each asset, enabling Nitro to serve assets without scanning the directory.

```json
{
  "/image.png": {
    "type": "image/png",
    "etag": "\"4a0c-6utWq0Kbk5OqDmksYCa9XV8irnM\"",
    "mtime": "2023-03-04T21:39:45.086Z",
    "size": 18956
  },
  "/robots.txt": {
    "type": "text/plain; charset=utf-8",
    "etag": "\"8-hMqyDrA8fJ0R904zgEPs3L55Jls\"",
    "mtime": "2023-03-04T21:39:45.086Z",
    "size": 8
  },
  "/video.mp4": {
    "type": "video/mp4",
    "etag": "\"9b943-4UwfQXKUjPCesGPr6J5j7GzNYGU\"",
    "mtime": "2023-03-04T21:39:45.085Z",
    "size": 637251
  }
}
```

--------------------------------

### Filesystem routing structure example

Source: https://nitro.build/docs/routing

Shows the filesystem routing structure: files in the `api/` or `routes/` directory are mapped to routes. Appending an HTTP method to the filename restricts the route to that method.

```text
routes/
  api/
    test.ts      <-- /api/test
  hello.get.ts   <-- /hello (GET only)
  hello.post.ts  <-- /hello (POST only)
vite.config.ts
```

--------------------------------

### Create server entry with renderToReadableStream

Source: https://nitro.build/examples/vite-ssr-react

The server entry renders your React app to a streaming HTML response. It uses `react-dom/server.edge` for edge-compatible streaming. Import assets using the `?assets=client` and `?assets=ssr` query parameters. Nitro collects CSS and JS assets from each entry point, and `merge()` combines them into a single manifest. The `assets` object provides arrays of stylesheet and script attributes, plus the client entry URL. Use `renderToReadableStream` to stream HTML as React renders, improving time-to-first-byte.

```tsx
import "./styles.css";
import { renderToReadableStream } from "react-dom/server.edge";
import { App } from "./app.tsx";

import clientAssets from "./entry-client?assets=client";
import serverAssets from "./entry-server?assets=ssr";

export default {
  async fetch(_req: Request) {
    const assets = clientAssets.merge(serverAssets);
    return new Response(
      await renderToReadableStream(
        <html lang="en">
          <head>
            <meta name="viewport" content="width=device-width, initial-scale=1.0" />
            {assets.css.map((attr: any) => (
              <link key={attr.href} rel="stylesheet" {...attr} />
            ))}
            {assets.js.map((attr: any) => (
              <link key={attr.href} rel="modulepreload" {...attr} />
            ))}
            <script type="module" src={assets.entry} />
          </head>
          <body id="app">
            <App />
          </body>
        </html>
      ),
      { headers: { "Content-Type": "text/html;charset=utf-8" } }
    );
  },
};
```

--------------------------------

### getQuery

Source: https://nitro.build/docs/utils

Gets the query parameters from an event.

```APIDOC
## getQuery

### Description
Gets the query parameters from an event.

### Import
```js
import { getQuery } from "nitro/h3"
```

### Usage
```js
import { getQuery } from "nitro/h3"

const query = getQuery(event)
```
```

--------------------------------

### Enable gzip and brotli pre-compression

Source: https://nitro.build/config

Enable pre-compression of public assets and prerendered routes larger than 1024 bytes. This example enables gzip and brotli compression using default compression levels.

```javascript
export default defineConfig({
  compressPublicAssets: {
    gzip: true,
    brotli: true, // enable gzip and brotli pre-compression
  },
});
```

--------------------------------

### Create server entry with createHandler and StartServer

Source: https://nitro.build/examples/vite-ssr-solidstart

Server entry that renders the Solid app to a streaming HTML response. Includes the @refresh reload comment for hot reload support.

```tsx
// @refresh reload
import { createHandler, StartServer } from "@solidjs/start/server";

export default createHandler(() => (
  <StartServer
    document={({ assets, children, scripts }) => (
      <html lang="en">
        <head>
          <meta charset="utf-8" />
          <meta name="viewport" content="width=device-width, initial-scale=1" />
          {assets}
        </head>
        <body>
          <div id="app">{children}</div>
          {scripts}
        </body>
      </html>
    )}
  />
));
```

--------------------------------

### Use NITRO_BUILDER environment variable

Source: https://nitro.build/docs/vite

Selects the Rollup builder via the `NITRO_BUILDER` environment variable without modifying the config file. If you explicitly select `rollup` or `vite` and the package is not installed, Nitro prompts to install it as a dev dependency.

```bash
NITRO_BUILDER=rollup nitro build
```

--------------------------------

### getRouteRules

Source: https://nitro.build/docs/utils

Get the resolved route rules for a method and pathname.

```APIDOC
## getRouteRules

### Description
Get the resolved route rules for a method and pathname: `getRouteRules("GET", "/blog/post")`.

### Import
```js
import { getRouteRules } from "nitro/app";
```

### Usage
```js
const rules = getRouteRules("GET", "/blog/post");
```

```

--------------------------------

### Koyeb CLI Login

Source: https://nitro.build/deploy/providers/koyeb

Log into your account with the Koyeb CLI. Paste your API credentials when prompted.

```bash
koyeb login
```

--------------------------------

### getKeys(base?)

Source: https://nitro.build/docs/storage

Get all keys, optionally filtered by a base prefix.

```APIDOC
## getKeys(base?)

### Description
Get all keys, optionally filtered by a base prefix.

### Method
Function

### Endpoint
`getKeys(base?)`

### Parameters
- **base** (string) - Optional - Base prefix to filter keys.

### Response
Returns an array of keys.

```

--------------------------------

### serverFetch / fetch

Source: https://nitro.build/docs/utils

Same as the main entry exports.

```APIDOC
## serverFetch / fetch

### Description
Same as the main entry exports.

### Import
```js
import { serverFetch, fetch } from "nitro/app";
```

```

--------------------------------

### getMeta(key)

Source: https://nitro.build/docs/storage

Get metadata for a key (e.g., mtime, atime, ttl).

```APIDOC
## getMeta(key)

### Description
Get metadata for a key (e.g., mtime, atime, ttl).

### Method
Function

### Endpoint
`getMeta(key)`

### Parameters
- **key** (string) - Required - The key to get metadata for.

### Response
Returns metadata object.

```

--------------------------------

### getItem(key)

Source: https://nitro.build/docs/storage

Get the value of a key. Returns null if the key does not exist.

```APIDOC
## getItem(key)

### Description
Get the value of a key. Returns null if the key does not exist.

### Method
Function

### Endpoint
`getItem(key)`

### Parameters
- **key** (string) - Required - The key to retrieve.

### Response
Returns the value associated with the key, or null if not found.

```

--------------------------------

### Preview the output with srvx

Source: https://nitro.build/deploy/runtimes/standard

Locally preview the build output using srvx. Note that the server does not serve static assets; public assets are emitted to the public/ directory and should be served by the hosting platform or a separate static file server.

```bash
cd .output
npx srvx --prod ./
```

--------------------------------

### Use storage methods getKeys, hasItem, removeItem, getItemRaw, getMeta

Source: https://nitro.build/docs/storage

Demonstrates additional storage methods: getKeys, hasItem, removeItem, getItemRaw for binary data, and getMeta for metadata. These methods are part of the storage instance returned by useKV().

```javascript
import { useKV } from "nitro/kv";

// Get all keys under a prefix
const keys = await useKV("test").getKeys();

// Check if a key exists
const exists = await useKV().hasItem("test:foo");

// Remove a key
await useKV().removeItem("test:foo");

// Get raw binary data
const raw = await useKV().getItemRaw("assets:server:image.png");

// Get metadata (type, etag, mtime, etc.)
const meta = await useKV("assets:server").getMeta("file.txt");
```

--------------------------------

### Import defineConfig from nitro

Source: https://nitro.build/config

Required import for all configuration examples on this page. Place this at the top of nitro.config.ts.

```typescript
import { defineConfig } from "nitro";
```

--------------------------------

### useKV()

Source: https://nitro.build/docs/storage

Access the storage instance. Optionally specify a base prefix. Supports generics for typed return values.

```APIDOC
## useKV()

### Description
Access the storage instance. Optionally specify a base prefix. Supports generics for typed return values.

### Method
Function

### Endpoint
`useKV(base?)`

### Parameters
- **base** (string) - Optional - Base prefix for all storage operations.

### Request Example
```js
import { useKV } from "nitro/kv";

// Default storage (in-memory)
await useKV().setItem("test:foo", { hello: "world" });
const value = await useKV().getItem("test:foo");

// With base prefix
const testStorage = useKV("test");
await testStorage.setItem("foo", { hello: "world" });
await testStorage.getItem("foo"); // { hello: "world" }

// With generics
await useKV<{ hello: string }>("test").getItem("foo");
await useKV("test").getItem<{ hello: string }>("foo");
```

### Response
Returns a storage instance with methods for key-value operations.

```

--------------------------------

### getItemRaw(key)

Source: https://nitro.build/docs/storage

Get the raw value of a key without parsing. Useful for binary data.

```APIDOC
## getItemRaw(key)

### Description
Get the raw value of a key without parsing. Useful for binary data.

### Method
Function

### Endpoint
`getItemRaw(key)`

### Parameters
- **key** (string) - Required - The key to retrieve.

### Response
Returns the raw value (e.g., Buffer or string) without parsing.

```

--------------------------------

### Configure server assets with baseName and dir

Source: https://nitro.build/config

Define server assets that can be accessed in server logic and bundled in production. This example bundles the ./templates directory under the baseName "templates".

```javascript
export default defineConfig({
  serverAssets: [
    {
      baseName: "templates",
      dir: "./templates", // bundle templates/ as server assets
    },
  ],
});
```

--------------------------------

### Deploy with Upsun CLI

Source: https://nitro.build/deploy/providers/upsun

Deploy the project using the Upsun CLI client.

```bash
upsun deploy
```

--------------------------------

### getItems(items)

Source: https://nitro.build/docs/storage

Get multiple items at once. Accepts an array of keys or { key, options } objects.

```APIDOC
## getItems(items)

### Description
Get multiple items at once. Accepts an array of keys or { key, options } objects.

### Method
Function

### Endpoint
`getItems(items)`

### Parameters
- **items** (array) - Required - Array of keys or objects with `key` and optional `options`.

### Response
Returns an array of items with their values.

```

--------------------------------

### nitro deploy command

Source: https://nitro.build/docs/cli

Builds the project and runs the deploy command of the selected preset. Use --prebuilt to skip the build step. Additional build flags and arguments after -- are passed to the deploy command.

```bash
npx nitro deploy [--dir <dir>] [--prebuilt] [build flags...] [-- <extra deploy args>]
```
Tokens:
Raw