Unclear documentation on socket.compress(value)
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
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.
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"?
- Dominant language
- JavaScript
- Stars
- 342
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from socketio/socket.io-website
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
socketio/socket.io-website#475 · 1 comment ·
-
The Replit and CodeSandbox interactive example links featured on the homepage under the "Basic example" section are currently broken and returning error pages.Possibly taken @Hashim1999164 claimed this 8 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 72/100
socketio/socket.io-website#551 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
socketio/socket.io-website#550 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
socketio/socket.io-website#539 · 7 comments ·
-
Step #7 Server delivery has multiple issuesPossibly taken @vipin8797 claimed this 124 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 38/100
socketio/socket.io-website#512 ·
All issues in socketio/socket.io-website
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 76/100
521xueweihan/HelloGitHub#3939 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
needs-website-changes
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
[Bug] critique requires the detector on native targets, but audit.native.md says it does not applyOpenneeds triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
pbakaus/impeccable#1017 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day