socketio / socketio/socket.io

make interface match browser WebSocket class?

Open
#5,080 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

package:engine.io
Dominant language
TypeScript
Stars
63.2k
Forks
10.3k
Avg merge
11d 20h
Merged PRs (30d)
2

Description

The engine.io client is so close to a polyfill for the browser WebSocket class that I wonder if it shouldn't match the interface? E.g. setting callbacks with onmessage = func instead of on('message', func) and so on. This way, projects that use the WebSocket class could support the engine.io client via simple dependency injection, rather than having to be made specifically aware of engine.io.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the engine.io client interface with the browser WebSocket class, focusing on callback assignment such as onmessage versus on('message', ...). The issue names no files or tests, so first clarify the full compatibility scope and acceptance criteria; done means the agreed interface behavior is implemented and verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
api, networking
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.