Skip to content

fortunejs/fortune-ws

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

WebSocket server and client for Fortune.js.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published