docs | ||
examples | ||
misc | ||
src | ||
tests | ||
uWebSockets@b6173d68b4 | ||
.gitmodules | ||
.travis.yml | ||
LICENSE | ||
Makefile | ||
README.md |
µWebSockets™ (it's "micro") is simple, secure & standards compliant web I/O for the most demanding[1] of applications.
Outrun, everyone.
This project is not your typical "web framework" a la 500 lines of JavaScript and a fancy logo. You're looking at a 3-part software suite of ~7k lines of C & C++, working in unison with Google V8 to bring you one of the most memory scalable and performant I/O scriping environment available.
No compiler needed.
We use AppVeyor & TravisCI to automatically pre-compile binaries for Linux, macOS and Windows with every push. New releases are tagged from branch binaries
and can be installed using NPM like so:
npm install uNetworking/uWebSockets.js#v15.1.0
where v15.1.0
is the particular Git tag you wanted to use.
In a nutshell
const uWS = require('uWebSockets.js');
const port = 3000;
uWS.SSLApp({
/* cert, key and such specified here, or use uWS.App */
}).get('/whatsmyuseragent', (res, req) => {
res.writeHeader(
'content-type', 'text/html; charset= utf-8'
).end(
'Your user agent is: ' + req.getHeader('user-agent')
);
}).get('/*', (res, req) => {
res.end('Wildcard route');
}).listen(port, (token) => {
if (token) {
console.log('Listening to port ' + port);
} else {
console.log('Failed to listen to port ' + port);
}
});
Streams
Proper streaming of huge data is supported over Http/Https and demonstrated with examples. Here's a shot of me watching real-time streamed HD video from Node.js while simultaneously scoring a 115k req/sec with wrk. For my computer, that's about 5x that of vanilla Node.js (without any HD video streaming/playing).
Benchmarks
Performance retention is about 65% that of the native C++ µWebSockets v0.15. That makes it some 20x as fast as Deno and even faster than most C++-only servers, all from within a JavaScript VM.
Http | WebSockets |
---|---|
Build from source
Recursively clone, and enter, this repo:
git clone --recursive https://github.com/uNetworking/uWebSockets.js.git
cd uWebSockets.js
For Unix (Linux, macOS):
make
For Windows (in an x64 developer terminal):
nmake Windows
Test it out
node examples/HelloWorld.js