Interface ConnectionOptions

Options common to every realtime connection, plus the driver selector.

interface ConnectionOptions {
    driver: RealtimeDriver;
    name: string;
    prefix?: string;
    [key: string]: unknown;
}

Hierarchy (View Summary)

ConnectionOptions
- RedisBroadcasterOptions

Indexable

[key: string]: unknown

Driver-specific options (see RedisBroadcasterOptions).

Index

Properties

driver name prefix?

Properties

driver

driver: RealtimeDriver

Which driver backs this connection.

name

name: string

The connection name, used to resolve it via realtimeManager.connection(name).

`Optional`prefix

prefix?: string

A key prefix/namespace applied to backend keys/channels.