JavaScript SDK

The SurrealDB SDK for JavaScript and TypeScript lets you easily connect to SurrealDB from any environment—frontend, backend, serverless, or embedded within your app. It supports connecting to remote or embedded databases, running queries, managing data and authentication, and subscribing to real-time updates with live queries.

Language and Engines

Frameworks

React

available

Solid.js

available

Vue.js

available

Next.js

coming soon

Angular

coming soon

Svelte

coming soon

Example projects

You can find example repositories that demonstrate how to integrate SurrealDB in a number of different environments:

Surreal Stickies (React)

A simple note-taking application built with SurrealDB, React, and Vite.

Surreal Stickies (SvelteKit)

A simple note-taking application built with SurrealDB, SvelteKit, and Vite.

Surreal Presence (React)

A demo project on how to create a realtime presence web application using SurrealDB Live Queries.

TypeScript Starter

A simple TypeScript starter project using Bun.

Contributing

To contribute to the SDK code, submit an Issue or Pull Request in the surrealdb.js repository. To contribute to this documentation, submit an Issue or Pull Request in the docs.surrealdb.com repository.

On this page

Was this page helpful?

What did you like?

What went wrong?