@@ -58,9 +58,9 @@ npm install ws
58
58
### Opt-in for performance
59
59
60
60
There are 2 optional modules that can be installed along side with the ws
61
- module. These modules are binary addons which improve certain operations.
62
- Prebuilt binaries are available for the most popular platforms so you don't
63
- necessarily need to have a C++ compiler installed on your machine.
61
+ module. These modules are binary addons that improve the performance of certain
62
+ operations. Prebuilt binaries are available for the most popular platforms so
63
+ you don't necessarily need to have a C++ compiler installed on your machine.
64
64
65
65
- ` npm install --save-optional bufferutil ` : Allows to efficiently perform
66
66
operations such as masking and unmasking the data payload of the WebSocket
@@ -75,6 +75,10 @@ variables. These might be useful to enhance security in systems where a user can
75
75
put a package in the package search path of an application of another user, due
76
76
to how the Node.js resolver algorithm works.
77
77
78
+ The ` utf-8-validate ` module is not needed and is not required, even if it is
79
+ already installed, regardless of the value of the ` WS_NO_UTF_8_VALIDATE `
80
+ environment variable, if [ ` buffer.isUtf8() ` ] [ ] is available.
81
+
78
82
## API docs
79
83
80
84
See [ ` /doc/ws.md ` ] ( ./doc/ws.md ) for Node.js-like documentation of ws classes and
@@ -482,6 +486,7 @@ We're using the GitHub [releases][changelog] for changelog entries.
482
486
483
487
[ MIT] ( LICENSE )
484
488
489
+ [ `buffer.isutf8()` ] : https://nodejs.org/api/buffer.html#bufferisutf8input
485
490
[ changelog ] : https://github.com/websockets/ws/releases
486
491
[ client-report ] : http://websockets.github.io/ws/autobahn/clients/
487
492
[ https-proxy-agent ] : https://github.com/TooTallNate/node-https-proxy-agent
0 commit comments