max-mapper / max-mapper/websocket-stream

Possibly deprecate in favor of ws::createWebSocketStream

Open
#163 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
667
Forks
110
PR merge metrics
No merged PRs in 30d

Description

I was strolling along the source code of ws and found a function called createWebSocketStream. I haven't tested it yet, but it seems to do similar things as this library. Should we point users here instead?

Contributor guide

No contributing guide indexed for this repository

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

Compare this library with ws's documented createWebSocketStream entry point, linked in the issue, and determine whether their behavior and intended use overlap. Review the repository's current usage and documentation before deciding whether users should be redirected or the library deprecated; the issue is done when that direction and its scope are agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.