@ws-kit/bun
Version:
Bun platform adapter for WS-Kit leveraging native WebSocket API with built-in pub/sub and low-latency message routing
25 lines • 839 B
TypeScript
import type { Server } from "bun";
import { BunPubSub } from "./pubsub.js";
/**
* Create a Bun Pub/Sub adapter instance.
*
* Returns a PubSubAdapter that uses Bun's native server.publish() for
* zero-copy broadcasting to all subscribed WebSocket connections in this
* process instance.
*
* **Usage**:
* ```typescript
* import { bunPubSub } from "@ws-kit/bun";
* import { createRouter } from "@ws-kit/zod";
* import { withPubSub } from "@ws-kit/pubsub";
*
* const server = await Bun.serve({...});
* const router = createRouter()
* .plugin(withPubSub({ adapter: bunPubSub(server) }));
* ```
*
* @param server - Bun Server instance for pub/sub
* @returns A PubSubAdapter that broadcasts to this Bun instance only
*/
export declare function bunPubSub(server: Server<any>): BunPubSub;
//# sourceMappingURL=adapter.d.ts.map