Stone.js API
    Preparing search index...

    Interface RealtimeOptions

    Options for the @Realtime decorator: a single connection's configuration (driver required).

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

    Hierarchy

    Indexable

    • [key: string]: unknown
    Index
    driver name? prefix? url?
    driver: RealtimeDriver

    Which driver backs this connection.

    name?: string

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

    prefix?: string

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

    url?: string

    The client endpoint (WebSocket URL) used by the isomorphic client.

    Settings
    Member Visibility

    On This Page
    Properties