booth

0.14.0 • Public • Published

booth

Booth provides symmetric Event API over websocket or unix domain socket

Alike socket.io, but less powerful. Simple Event API, simple reconnect strategy, symmetric usage via Endpoint() on both client and server sides.

api

/*
 * options: WebSocket.Server options
 */
var booth = Booth(options)
 
/* port */
var booth = Booth({ port: 9000 })
 
/*
 * httpServer instance
 * for using inside working http server
 * or with unix domain socket
 */
var booth = Booth({ server })
 
booth.on('name', handler)
booth.on({ name: handler })
 
function handler (data, endpoint) { /* … */ }
 
/*
 * ws_uri: string with ws or ws+unix uri
 */
Endpoint(ws_uri)
 
/* websocket */
Endpoint('ws://localhost:9000')
 
/* unix domain socket */
Endpoint('ws+unix://localhost:9000')
 
endpoint.on('name', handler)
endpoint.on({ name: handler })
 
function handler (data, endpoint) { /* … */ }

license

ISC. Copyright © 2019, Strider.

Readme

Keywords

none

Package Sidebar

Install

npm i booth

Weekly Downloads

10

Version

0.14.0

License

ISC

Unpacked Size

6.86 kB

Total Files

8

Last publish

Collaborators

  • streetstrider