@@ -57,7 +57,7 @@ npm install ws
57
57
58
58
### Opt-in for performance
59
59
60
- ` bufferutil ` is an optional module that can be installed alongside the ` ws `
60
+ [ bufferutil] [ ] is an optional module that can be installed alongside the ws
61
61
module:
62
62
63
63
```
@@ -69,24 +69,24 @@ as masking and unmasking the data payload of the WebSocket frames. Prebuilt
69
69
binaries are available for the most popular platforms, so you don't necessarily
70
70
need to have a C++ compiler installed on your machine.
71
71
72
- To force ` ws ` to not use ` bufferutil ` , use the
72
+ To force ws to not use bufferutil, use the
73
73
[ ` WS_NO_BUFFER_UTIL ` ] ( ./doc/ws.md#ws_no_buffer_util ) environment variable. This
74
74
can be useful to enhance security in systems where a user can put a package in
75
75
the package search path of an application of another user, due to how the
76
76
Node.js resolver algorithm works.
77
77
78
78
#### Legacy opt-in for performance
79
79
80
- If you are running on an old version of Node.js (prior to v18.14.0), ` ws ` also
81
- supports the ` utf-8-validate ` module:
80
+ If you are running on an old version of Node.js (prior to v18.14.0), ws also
81
+ supports the [ utf-8-validate] [ ] module:
82
82
83
83
```
84
84
npm install --save-optional utf-8-validate
85
85
```
86
86
87
87
This contains a binary polyfill for [ ` buffer.isUtf8() ` ] [ ] .
88
88
89
- To force ` ws ` to not use ` utf-8-validate ` , use the
89
+ To force ws to not use utf-8-validate, use the
90
90
[ ` WS_NO_UTF_8_VALIDATE ` ] ( ./doc/ws.md#ws_no_utf_8_validate ) environment variable.
91
91
92
92
## API docs
@@ -533,6 +533,7 @@ We're using the GitHub [releases][changelog] for changelog entries.
533
533
[ MIT] ( LICENSE )
534
534
535
535
[ `buffer.isutf8()` ] : https://nodejs.org/api/buffer.html#bufferisutf8input
536
+ [ bufferutil ] : https://github.com/websockets/bufferutil
536
537
[ changelog ] : https://github.com/websockets/ws/releases
537
538
[ client-report ] : http://websockets.github.io/ws/autobahn/clients/
538
539
[ https-proxy-agent ] : https://github.com/TooTallNate/node-https-proxy-agent
@@ -543,4 +544,5 @@ We're using the GitHub [releases][changelog] for changelog entries.
543
544
[ server-report ] : http://websockets.github.io/ws/autobahn/servers/
544
545
[ session-parse-example ] : ./examples/express-session-parse
545
546
[ socks-proxy-agent ] : https://github.com/TooTallNate/node-socks-proxy-agent
547
+ [ utf-8-validate ] : https://github.com/websockets/utf-8-validate
546
548
[ ws-server-options ] : ./doc/ws.md#new-websocketserveroptions-callback
0 commit comments