A cute WebSocket library
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
README.md
package.json
socket.js

README.md

cute-socket

js-standard-style stability

A cute WebSocket library, intended to use with Browserify or Webpack.

Install

npm i cute-socket --save

Usage

const socket = require('cute-socket')('ws://localhost:3000')

socket.on('open', () => {
  socket.send('hello!')
  console.log('socket opened!')
})

socket.on('message', msg => {
  console.log('New message:', msg)
})

Custom events are supported via JSON.
Example:

// JSON:
// {
//    event: 'custom-event'
//    message: 'hello world!',
//    payload: 'eiubgoerunf984h3r8f8hr04f'
//  }

socket.on('custom-event', msg => console.log) // Will print the above json object

API

.on(event, callback)

Register a callback for the given event.

  • 'open'
  • 'close'
  • 'message'
  • 'error'

Custom events are also supported if the message is a JSON with an 'event' field.

.off(event)

Unregister from an event.

.send(payload)

Sends data through the socket, the payload must be a string or binary data.

.close()

Close the socket connection.

Contributing

If you feel you can help in any way, be it with examples, extra testing, or new features please open a pull request or open an issue.

The code follows the Standard code style.
js-standard-style

License

MIT

The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non infringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

Copyright © 2017 Tomas Della Vedova