Setup

Installation

Install nuxt-surrealdb in your Nuxt application.

pnpm add nuxt-surrealdb

npm install nuxt-surrealdb

bun add nuxt-surrealdb

yarn add nuxt-surrealdb

Getting started

Add nuxt-surrealdb to your modules in nuxt.config.ts:

export default defineNuxtConfig({
  modules: [
    'nuxt-surrealdb',
  ],
})

Then configure your SurrealDB endpoint:

export default defineNuxtConfig({
  modules: ['nuxt-surrealdb'],
  surrealdb: {
    client: {
      endpoint: 'http://localhost:8000',
      connectOptions: {
        namespace: 'my_ns',
        database: 'my_db',
      },
    },
  },
})

That's it! You can now use Nuxt SurrealDB in your Nuxt app.

Optional peer dependencies

The core module uses the surrealdb JavaScript SDK to connect to a remote SurrealDB instance. For embedded (in-process) engines, install the optional peer dependencies:

Client-side WASM engine

To run SurrealDB in-memory or with IndexedDB storage on the client side:

pnpm add @surrealdb/wasm

Server-side Node engine

To run SurrealDB in-memory or with SurrealKV local storage on the server side:

pnpm add @surrealdb/node

The module auto-detects which packages are available and enables the corresponding features automatically.