JavaScript client library

@basalt/client is the isomorphic JavaScript library for Basalt. Use it to query your database, listen to changes, sign users in and manage files, from a browser, a server or an edge runtime.

Installing

Install the package from npm. It has no runtime dependencies and ships its own TypeScript types.

npm
yarn
pnpm

npm install @basalt/client

yarn add @basalt/client

pnpm add @basalt/client

Initializing

Create one client per app and reuse it. The URL and publishable key are on your project's API settings page.

import { createClient } from '@basalt/client'

const basalt = createClient(
  'https://abcd1234.basalt.run',
  'bpk_live_xxxxxxxx',
)

Updated Oct 12, 2026

Was this page helpful?