Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / realtime / realtime

Function: realtime() ​

realtime(config): <Schema>(client) => WebSocketClient<Schema>

Defined in: realtime/composable.ts:40

Creates a client to communicate with a Directus REST WebSocket.

Parameters ​

config ​

WebSocketConfig = {}

The optional configuration.

Returns ​

Function

A Directus realtime client.

Type Parameters ​

• Schema

Parameters ​

client ​

DirectusClient<Schema>

Returns ​

WebSocketClient<Schema>