WebSocket server and client for Fortune.js.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
LICENSE
README.md
package.json

README.md

Fortune WebSocket

Build Status npm Version License

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.