socketio / socketio/socket.io-website
Unclear documentation on socket.compress(value)
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 342
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Description
The text here is a bit unclear about when compression is used.
As I understand it, websocket compression is turned off by default. This means that setting socket.compress(true) will not necessarily turn on compression (when using the websocket transport, anyway). Did I get that right? Could it be made clearer with an explicit sentence like "Whether compression is actually used also depends on whether it is enabled in the underlying transport"?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the Socket.IO v3 Server API section for socket.compress(value) linked in the issue and review its explanation of transport compression. Clarify that calling socket.compress(true) does not by itself enable compression when the underlying transport has compression disabled. Done when the documentation makes that dependency explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100