Install

Add voltbase-js to a browser or Node app.

npm / pnpm / yarn

terminal

npm install voltbase-js

terminal

pnpm add voltbase-js

terminal

yarn add voltbase-js

createClient

index.ts

import { createClient } from 'voltbase-js';

const voltbase = createClient(projectUrl, apiKey);

projectUrl is the Project URL from the dashboard API page (includes /api/projects/…). apiKey is either the anon or service role JWT.

Client surface

index.ts

createClient(projectUrl, apiKey) → VoltbaseClient

client.from(table)      // same as client.db.from(table)
client.rpc(fn, args?)   // POST /rest/rpc/:fn
client.db
client.auth
client.storage
client.realtime