47 lines
13 KiB
JSON
47 lines
13 KiB
JSON
|
{
|
||
|
"name": "websocket",
|
||
|
"description": "Websocket Client & Server Library implementing the WebSocket protocol as specified in RFC 6455.",
|
||
|
"keywords": [
|
||
|
"websocket",
|
||
|
"websockets",
|
||
|
"socket",
|
||
|
"networking",
|
||
|
"comet",
|
||
|
"push"
|
||
|
],
|
||
|
"author": {
|
||
|
"name": "Brian McKelvey",
|
||
|
"email": "brian@worlize.com",
|
||
|
"url": "https://www.worlize.com/"
|
||
|
},
|
||
|
"version": "1.0.8",
|
||
|
"repository": {
|
||
|
"type": "git",
|
||
|
"url": "http://github.com/Worlize/WebSocket-Node.git"
|
||
|
},
|
||
|
"engines": {
|
||
|
"node": ">=0.6.10"
|
||
|
},
|
||
|
"config": {
|
||
|
"verbose": false
|
||
|
},
|
||
|
"scripts": {
|
||
|
"install": "node install.js"
|
||
|
},
|
||
|
"main": "index",
|
||
|
"directories": {
|
||
|
"lib": "./lib"
|
||
|
},
|
||
|
"readme": "WebSocket Client & Server Implementation for Node\n=================================================\n\nOverview\n--------\nThis is a (mostly) pure JavaScript implementation of the WebSocket protocol versions 8 and 13 for Node. There are some example client and server applications that implement various interoperability testing protocols in the \"test\" folder.\n\nCurrent News\n------------\n\n- As of version 1.0.7, ***Native modules are now optional.*** If they fail to compile, WebSocket-Node will still work but will not verify that received UTF-8 data is valid, and xor masking/unmasking of payload data for security purposes will not be as efficient as it is performed in JavaScript instead of native code.\n\n- Version 1.0.7 requires node v0.6.10, since that's the first version that I can manage to successfully build the native extensions with node-gyp through npm. If anyone can figure out how to build native extensions in a way that works with both older and newer versions of Node, I'm happy to accept a patch!\n\n- If you want to support Unicode characters outside the Basic Multilingual Plane (BMP) you must use Node v0.8.x, which added support for representing these characters as surrogate pairs inside JavaScript strings. Under Node v0.6.x, characters with code points greater than 65535 (greater than a 16-bit unsigned value) will have their code point truncated, resulting in seemingly unpredictable characters being returned.\n\n- WebSocket-Node was already [one of the fastest WebSocket libraries for Node](http://hobbycoding.posterous.com/websockt-binary-data-transfer-benchmark-rsult), and thanks to a small patch from [kazuyukitanimura](https://github.com/kazuyukitanimura), this library is now [up to 200% faster](http://hobbycoding.posterous.com/how-to-make-websocket-work-2x-faster-on-nodej) as of version 1.0.3!\n\nChangelog\n---------\n\nCurrent Version: 1.0.7\n\n[View the changelog](https://github.com/Worlize/WebSocket-Node/blob/master/CHANGELOG.md)\n\nBrowser Support\n---------------\n\n* Firefox 7-9 (Old) (Protocol Version 8)\n* Firefox 10+ (Protocol Version 13)\n* Chrome 14,15 (Old) (Protocol Version 8)\n* Chrome 16+ (Protocol Version 13)\n* Internet Explorer 10 (Preview) (Protocol Version 13)\n* Safari 6 (Protocol Version 13)\n\n***Safari older than 6.0 is not supported since it uses a very old draft of WebSockets***\n\nI made a decision early on to explicitly avoid maintaining multiple slightly different copies of the same code just to support the browsers currently in the wild. The major browsers that support WebSocket are on a rapid-release schedule (with the exception of Safari) and now that the final version of the protocol has been [published as an official RFC](http://datatracker.ietf.org/doc/rfc6455/), it won't be long before support in the wild stabilizes on that version. My client application is in Flash/ActionScript 3, so for my purposes I'm not dependent on the browser implementations. *I made an exception to my stated intention here to support protocol version 8 along with 13, since only one minor thing changed and it was trivial to handle conditionally.* The library now interoperates with other clients and servers implementing draft -08 all the way up through the final RFC.\n\n***If you need to simultaneously support legacy browser versions that had implemented draft-75/draft-76/draft-00, take a look here: https://gist.github.com/1428579***\n\nFor a WebSocket client written in ActionScript 3, see my [AS3WebScocket](https://github.com/Worlize/AS3WebSocket) project.\n\nBenchmarks\n----------\nThere are some basic benchmarking sections in the Autobahn test suite. I've put up a [benchmark page](http://worlize.github.com/WebSocket-Node/benchmarks/) that shows the results from the Autobahn tests run against AutobahnServer 0.4.10, WebSocket-Node 1.0.2, WebSocket-Node 1.0.4, and ws 0.3.4.\n\nAutobahn Tests\n--------------\nThe very complete [Autobahn Test Suite](http://www.tavendo.de/autobahn/testsuite.html) is used by most WebSocket implementations to test spec compliance and interopera
|
||
|
"readmeFilename": "README.md",
|
||
|
"bugs": {
|
||
|
"url": "https://github.com/Worlize/WebSocket-Node/issues"
|
||
|
},
|
||
|
"_id": "websocket@1.0.8",
|
||
|
"dist": {
|
||
|
"shasum": "924e9af90ae4e6d498f16d1208928ca6c89b6131"
|
||
|
},
|
||
|
"_from": "websocket@",
|
||
|
"_resolved": "https://registry.npmjs.org/websocket/-/websocket-1.0.8.tgz"
|
||
|
}
|