Class Channel<Value>

constructor

• new Channel<Value>(id?, initial?): Channel<Value>

• Create a new Channel

  Type Parameters

  • Value extends Content = Content

  Parameters

  • Optional id: null | number
  • Optional initial: Content

  Returns Channel<Value>

  Example

  import { Server, Channel } from "rjweb-server"
  import { Runtime } from "@rjweb/runtime-bun"
  
  const echo = new Channel<string>()
  
  const server = new Server(Runtime, {
    port: 8000
  })
  
  server.path('/', (path) => path
    .ws('/echo', (ws) => ws
      .onOpen((ctr) => {
        ctr.printChannel(echo)
      })
      .onMessage((ctr) => {
        echo.send(ctr.rawMessage()) // will send the message to all subscribed sockets
      })
    )
    .http('GET', '/last-echo', (http) => http
      .onRequest((ctr) => {
        return ctr.print(echo.last())
      })
    )
  )
  
  server.start().then(() => console.log('Server Started!'))
  Copy

  Since

  9.0.0

Readonly id

last

• last(): null | Value

• Get the last sent value

  Returns null | Value

  Since

  9.0.0

listen

• listen(callback): (() => void)

• Listen for send events on this Channel

  Parameters

  • callback: Listener<Value>

  Returns (() => void)

  • • (): void

    • Returns void

  Since

  9.0.0

send

• send(type, data, prettify?): Promise<Channel<Value>>

• Send Data to each Subscriber (and listener)

  Parameters

  • type: "binary" | "text"
  • data: Value
  • prettify: boolean = false

  Returns Promise<Channel<Value>>

  Since

  9.0.0