FluxbaseRealtime

Constructors

new FluxbaseRealtime(url, token): FluxbaseRealtime

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

channel(channelName, config?): RealtimeChannel

Create or get a channel with optional configuration

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

RealtimeChannel instance

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

removeAllChannels(): void

Remove all channels

void

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

Remove a specific channel

Parameter	Type	Description
`channel`	`RealtimeChannel`	The channel to remove

Promise<"error" | "ok">

Promise resolving to status

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

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.

Parameter	Type	Description
`token`	`null` \| `string`	The new auth token

void