fortune-ws
v1.0.4
Published
WebSocket implementation for Fortune.js.
Downloads
6
Readme
Fortune WebSocket
This is a WebSocket implementation for Fortune.js, which implements a wire protocol based on MessagePack.
$ npm install fortune-ws --save
Usage
Consult the source code or the documentation website for more information.
const fortuneWS = require('fortune-ws')
// Pass in a Fortune instance and an optional change function,
// options object, and connection callback.
const server = fortuneWS(instance, change, options, callback)
// There is also a client request function.
const promise = fortuneWS.request(client, options, state)
// Automatically syncing client, given a Fortune instance.
const listener = fortuneWS.sync(client, instance)
The browser version includes the client implementations but not the server.
License
This software is licensed under the MIT license.