@liveblocks/server

@liveblocks/server provides the APIs to run a Liveblocks server yourself.

Installation

bun install @liveblocks/server

Architecture

classDiagram
  Room --> Store : store
  Room --> "0+" Session : sessions
  Session --> WebSocket

  class Room {
    +roomId
    +load()
    +createTicket(version) Ticket
    +startBrowserSession(Ticket ticket, WebSocket socket)
    +handleRaw(Ticket ticket, data)
    +endBrowserSession(Ticket ticket, code, reason)
  }

  class Store {
    +getString(key)
    +getNumber(key)
    +put(key, value)
  }

  class Session{
    +version
    +actor
    +nonce
    +createdAt
    +lastPong
    +sendPong()
    +sendServerMsg()
  }

  class WebSocket {
    +...
  }

License

Licensed under the GNU Affero General Public License v3.0 or later, Copyright © 2021-present Liveblocks.

See LICENSE-AGPL-3.0 for more information.