@@ -57,7 +57,7 @@ npm install ws
5757
5858### Opt-in for performance
5959
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
6161module:
6262
6363```
@@ -69,24 +69,24 @@ as masking and unmasking the data payload of the WebSocket frames. Prebuilt
6969binaries are available for the most popular platforms, so you don't necessarily
7070need to have a C++ compiler installed on your machine.
7171
72- To force ` ws ` to not use ` bufferutil ` , use the
72+ To force ws to not use bufferutil, use the
7373[ ` WS_NO_BUFFER_UTIL ` ] ( ./doc/ws.md#ws_no_buffer_util ) environment variable. This
7474can be useful to enhance security in systems where a user can put a package in
7575the package search path of an application of another user, due to how the
7676Node.js resolver algorithm works.
7777
7878#### Legacy opt-in for performance
7979
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:
8282
8383```
8484npm install --save-optional utf-8-validate
8585```
8686
8787This contains a binary polyfill for [ ` buffer.isUtf8() ` ] [ ] .
8888
89- To force ` ws ` to not use ` utf-8-validate ` , use the
89+ To force ws to not use utf-8-validate, use the
9090[ ` WS_NO_UTF_8_VALIDATE ` ] ( ./doc/ws.md#ws_no_utf_8_validate ) environment variable.
9191
9292## API docs
@@ -533,6 +533,7 @@ We're using the GitHub [releases][changelog] for changelog entries.
533533[ MIT] ( LICENSE )
534534
535535[ `buffer.isutf8()` ] : https://nodejs.org/api/buffer.html#bufferisutf8input
536+ [ bufferutil ] : https://github.com/websockets/bufferutil
536537[ changelog ] : https://github.com/websockets/ws/releases
537538[ client-report ] : http://websockets.github.io/ws/autobahn/clients/
538539[ 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.
543544[ server-report ] : http://websockets.github.io/ws/autobahn/servers/
544545[ session-parse-example ] : ./examples/express-session-parse
545546[ socks-proxy-agent ] : https://github.com/TooTallNate/node-socks-proxy-agent
547+ [ utf-8-validate ] : https://github.com/websockets/utf-8-validate
546548[ ws-server-options ] : ./doc/ws.md#new-websocketserveroptions-callback
0 commit comments