Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: make websocket an optional peer dependency #291

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

jazmon
Copy link

@jazmon jazmon commented Dec 2, 2024

This PR makes the websocket dependency a peer dependency.

The motivation for this change

  • The websocket dependency is not used in all cases, only with the streaming client
  • websocket dependency is arguably worse than ws and websocket pulls in a lot of native dependencies. It's a common practice that any dependency that pulls in websocket has it as an optional peer dependency for that given reason.

Additionally, this PR adds an engines definition and a packageManager field to make the expected tools easier to discover.

@jazmon jazmon requested a review from a team as a code owner December 2, 2024 11:59
Copy link
Contributor

github-actions bot commented Jan 2, 2025

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days

@github-actions github-actions bot added the Stale label Jan 2, 2025
@jazmon
Copy link
Author

jazmon commented Jan 2, 2025

Not stale

@github-actions github-actions bot removed the Stale label Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants