- super simple API for working with WebSockets in the browser
- supports text and binary data
- node.js duplex stream interface
This module works in the browser with browserify, and it's used by WebTorrent!
npm install simple-websocket
var SimpleWebsocket = require('simple-websocket')
var socket = new SimpleWebsocket('ws://echo.websocket.org')
socket.on('connect', function () {
// socket is connected!
socket.send('sup!')
})
socket.on('data', function (data) {
console.log('got message: ' + data)
})
Note: If you're NOT using browserify, then use the standalone simplewebsocket.bundle.js
file included in this repo. This exports a SimpleWebsocket
function on the window
.
Create a new WebSocket connection.
If opts
is specified, then it will be passed through to the underlying superclass, stream.Duplex
.
Send text/binary data to the WebSocket server. data
can be any of several types:
String
, Buffer
(see buffer), TypedArrayView
(Uint8Array
, etc.), ArrayBuffer
, or Blob
(in browsers that support it).
Other data types will be transformed with JSON.stringify
before sending. This is handy
for sending object literals across like this: socket.send({ type: 'data', data: 'hi' })
.
Note: If this method is called before the socket.on('connect')
event has fired, then
data will be buffered.
Destroy and cleanup this websocket connection.
If the optional onclose
paramter is passed, then it will be registered as a listener on the 'close' event.
Fired when the websocket connection is ready to use.
Received a message from the websocket server.
data
will be either a String
or a Buffer/Uint8Array
(see buffer).
Called when the websocket connection has closed.
err
is an Error
object.
Fired when a fatal error occurs. If the reconnect
option is set to something truthy (defaults to 5000
), then this event will never get emitted because the socket will automatically reconnect on error.
err
is an Error
object.
Fired when an error occurs but an auto-reconnect will be attempted. Thus, it's only a warning
, not a full-fledged error
.
- StudyNotes - Helping students learn faster and better
- instant.io - Secure, anonymous, streaming file transfer
- lxjs-chat - Omegle chat clone
- [ your application here - send a PR ]
MIT. Copyright (c) Feross Aboukhadijeh.