Function createHonoWebSocketHandler

createHonoWebSocketHandler<API extends Record<string, any>>(
    options: HonoWebSocketOptions<API>,
): {
    onClose(): void;
    onError(event: Event, ws: any): void;
    onMessage(event: MessageEvent, ws: any): void;
    onOpen(event: Event, ws: any): void;
}

Creates a Hono WebSocket handler that integrates kkrpc with Hono's upgradeWebSocket

This function works with Hono's upgradeWebSocket from:

hono/bun
hono/deno
hono/cloudflare-workers

Type Parameters

API extends Record<string, any>

Parameters

options: HonoWebSocketOptions<API>

Returns {
    onClose(): void;
    onError(event: Event, ws: any): void;
    onMessage(event: MessageEvent, ws: any): void;
    onOpen(event: Event, ws: any): void;
}

Example

// Bun example
import { Hono } from 'hono'
import { upgradeWebSocket, websocket } from 'hono/bun'
import { createHonoWebSocketHandler } from 'kkrpc'

const app = new Hono()

app.get('/ws', upgradeWebSocket(() => {
  return createHonoWebSocketHandler({
    expose: myAPI
  })
}))

Bun.serve({
  fetch: app.fetch,
  websocket
})

Example

// Deno example
import { Hono } from 'hono'
import { upgradeWebSocket } from 'hono/deno'
import { createHonoWebSocketHandler } from 'kkrpc'

const app = new Hono()

app.get('/ws', upgradeWebSocket(() => {
  return createHonoWebSocketHandler({
    expose: myAPI
  })
}))

Deno.serve({ fetch: app.fetch, port: 8000 })

Function createHonoWebSocketHandler

Type Parameters

Parameters

Returns { onClose(): void; onError(event: Event, ws: any): void; onMessage(event: MessageEvent, ws: any): void; onOpen(event: Event, ws: any): void;}

Example

Example

Settings

Returns {
onClose(): void;
onError(event: Event, ws: any): void;
onMessage(event: MessageEvent, ws: any): void;
onOpen(event: Event, ws: any): void;
}