FluxbaseClient

Main Fluxbase client class

Type Parameters

Type Parameter	Default type
Database	any
_SchemaName extends string & keyof Database	any

Constructors

new FluxbaseClient()

new FluxbaseClient<Database, _SchemaName>(fluxbaseUrl, fluxbaseKey, options?): FluxbaseClient<Database, _SchemaName>

Create a new Fluxbase client instance

Parameters

Parameter	Type	Description
fluxbaseUrl	string	The URL of your Fluxbase instance
fluxbaseKey	string	The anon key (JWT token with “anon” role). Generate using scripts/generate-keys.sh
options?	FluxbaseClientOptions	Additional client configuration options

Returns

FluxbaseClient<Database, _SchemaName>

Example

const client = new FluxbaseClient(
  'http://localhost:8080',
  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',  // Anon JWT token
  { timeout: 30000 }
)

Advanced

http

Get Signature

get http(): FluxbaseFetch

Get the internal HTTP client

Use this for advanced scenarios like making custom API calls or admin operations.

Example

// Make a custom API call
const data = await client.http.get('/api/custom-endpoint')

Returns

FluxbaseFetch

The internal FluxbaseFetch instance

Authentication

getAuthToken()

getAuthToken(): null | string

Get the current authentication token

Returns

null | string

The current JWT access token, or null if not authenticated

---

setAuthToken()

setAuthToken(token): void

Set a new authentication token

This updates both the HTTP client and realtime connection with the new token.

Parameters

Parameter	Type	Description
token	null | string	The JWT access token to set, or null to clear authentication

Returns

void

Database

from()

from<T>(table): QueryBuilder<T>

Create a query builder for a database table

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type	Description
table	string	The table name (can include schema, e.g., ‘public.users’)

Returns

QueryBuilder<T>

A query builder instance for constructing and executing queries

Example

// Simple select
const { data } = await client.from('users').select('*').execute()

// With filters
const { data } = await client.from('products')
  .select('id, name, price')
  .gt('price', 100)
  .eq('category', 'electronics')
  .execute()

// Insert
await client.from('users').insert({ name: 'John', email: 'john@example.com' }).execute()

---

rpc()

rpc<T>(functionName, params?): Promise<object>

Call a PostgreSQL function (Remote Procedure Call)

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type	Description
functionName	string	The name of the PostgreSQL function to call
params?	Record<string, unknown>	Optional parameters to pass to the function

Returns

Promise<object>

Promise containing the function result or error

Name	Type
data	null | T
error	null | Error

Example

// Call a function without parameters
const { data, error } = await client.rpc('get_total_users')

// Call a function with parameters
const { data, error } = await client.rpc('calculate_discount', {
  product_id: 123,
  coupon_code: 'SAVE20'
})

---

schema()

schema(schemaName): SchemaQueryBuilder

Access a specific database schema

Use this to query tables in non-public schemas.

Parameters

Parameter	Type	Description
schemaName	string	The schema name (e.g., ‘jobs’, ‘analytics’)

Returns

SchemaQueryBuilder

A schema query builder for constructing queries on that schema

Example

// Query the jobs.execution_logs table
const { data } = await client
  .schema('jobs')
  .from('execution_logs')
  .select('*')
  .eq('job_id', jobId)
  .execute()

// Insert into a custom schema table
await client
  .schema('analytics')
  .from('events')
  .insert({ event_type: 'click', data: {} })
  .execute()

Other

admin

admin: FluxbaseAdmin

Admin module for instance management (requires admin authentication)

---

auth

auth: FluxbaseAuth

Authentication module for user management

---

functions

functions: FluxbaseFunctions

Functions module for invoking and managing edge functions

---

jobs

jobs: FluxbaseJobs

Jobs module for submitting and monitoring background jobs

---

management

management: FluxbaseManagement

Management module for API keys, webhooks, and invitations

---

realtime

realtime: FluxbaseRealtime

Realtime module for WebSocket subscriptions

---

settings

settings: SettingsClient

Settings module for reading public application settings (respects RLS policies)

---

storage

storage: FluxbaseStorage

Storage module for file operations

Realtime

channel()

channel(name, config?): RealtimeChannel

Create or get a realtime channel (Supabase-compatible)

Parameters

Parameter	Type	Description
name	string	Channel name
config?	RealtimeChannelConfig	Optional channel configuration

Returns

RealtimeChannel

RealtimeChannel instance

Example

const channel = client.channel('room-1', {
  broadcast: { self: true },
  presence: { key: 'user-123' }
})
  .on('broadcast', { event: 'message' }, (payload) => {
    console.log('Message:', payload)
  })
  .subscribe()

---

removeChannel()

removeChannel(channel): Promise<"error" | "ok">

Remove a realtime channel (Supabase-compatible)

Parameters

Parameter	Type	Description
channel	RealtimeChannel	The channel to remove

Returns

Promise<"error" | "ok">

Promise resolving to status

Example

const channel = client.channel('room-1')
await client.removeChannel(channel)