uWebSockets.js/README.md

37 lines
1.2 KiB
Markdown
Raw Normal View History

2018-11-04 23:00:00 +00:00
**µWebSockets.js** is a JavaScript platform, runtime and web server. It can serve Http about 6x that of Node.js and 12x that of Deno and outperforms Golang's fasthttp with ease.
There are two modes; compiled as a stand-alone JavaScript runtime or as a Node.js native addon.
2018-07-28 20:48:22 +00:00
```javascript
2018-11-04 23:00:00 +00:00
/* The stand-alone runtime has uWS namespace already loaded. */
var uWS = uWS ? uWS : require('../dist/uws.js');
const world = 'Strings are slower than ArrayBuffer but who cares for demo purose!';
const port = 3000;
2018-07-28 20:48:22 +00:00
2018-11-04 23:00:00 +00:00
uWS.App().get('/hello', (res, req) => {
res.end(world);
2018-10-04 21:18:50 +00:00
}).get('/*', (res, req) => {
2018-11-04 23:00:00 +00:00
res.writeHeader('content-type', 'text/html; charset= utf-8').end(req.getHeader('user-agent') + ' är din user agent, biatch!');
}).listen(port, (token) => {
if (token) {
console.log('Listening to port ' + port);
} else {
console.log('Failed to listen to port ' + port);
}
2018-10-04 21:18:50 +00:00
});
2018-07-28 20:48:22 +00:00
```
2018-11-03 11:45:56 +00:00
### Benchmarks
Performance retention is up to 70% of native C++ µWebSockets v0.15.
![](benchmarks.png)
2018-11-03 23:17:07 +00:00
### Kick-start
2018-11-04 23:00:00 +00:00
Easiest is to compile yourself a Node.js native addon. The following works for Linux and macOS systems:
2018-11-03 23:17:07 +00:00
```
2018-11-04 23:00:00 +00:00
git clone --recursive https://github.com/uNetworking/uWebSockets.js.git
cd uWebSockets.js
2018-11-03 23:17:07 +00:00
make
node examples/HelloWorld.js
```