FluxbaseRealtime

Constructors

Constructor

new FluxbaseRealtime(url, token?): FluxbaseRealtime

Parameters

Parameter	Type	Default value
url	string	undefined
token	string | null	null

Returns

FluxbaseRealtime

Methods

channel()

channel(channelName, config?): RealtimeChannel

Create or get a channel with optional configuration

Parameters

Parameter	Type	Description
channelName	string	Channel name (e.g., ‘table:public.products’)
config?	RealtimeChannelConfig	Optional channel configuration

Returns

RealtimeChannel

RealtimeChannel instance

Example

const channel = realtime.channel('room-1', {
  broadcast: { self: true, ack: true },
  presence: { key: 'user-123' }
})

---

executionLogs()

executionLogs(executionId, type?): ExecutionLogsChannel

Create an execution log subscription channel

This provides a cleaner API for subscribing to execution logs (functions, jobs, or RPC procedures).

Parameters

Parameter	Type	Default value	Description
executionId	string	undefined	The execution ID to subscribe to
type	ExecutionType	"function"	The type of execution (‘function’, ‘job’, ‘rpc’)

Returns

ExecutionLogsChannel

ExecutionLogsChannel instance with fluent API

Example

const channel = client.realtime.executionLogs('exec-123', 'function')
  .onLog((log) => {
    console.log(`[${log.level}] ${log.message}`)
  })
  .subscribe()

---

removeAllChannels()

removeAllChannels(): void

Remove all channels

Returns

void

---

removeChannel()

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

Remove a specific channel

Parameters

Parameter	Type	Description
channel	RealtimeChannel	The channel to remove

Returns

Promise<"error" | "ok">

Promise resolving to status

Example

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

---

setAuth()

setAuth(token): void

Update auth token for all channels Updates both the stored token for new channels and propagates the token to all existing connected channels.

Parameters

Parameter	Type	Description
token	string | null	The new auth token

Returns

void