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: header options for WS and REST #250

Merged
merged 2 commits into from
Apr 21, 2024
Merged

Conversation

IdkGoodName
Copy link
Contributor

@IdkGoodName IdkGoodName commented Apr 21, 2024

Adds headers to options to both WS and REST to allow easier access to Guilded API experiments today and in the future. This also adds client option ws that will be handed to the WebSocket directly (which is what is done to REST as of now).

Status

  • Code changes have been tested.

Semantic versioning classification:

  • This PR changes the library's interface (methods or parameters added)
  • This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
  • This PR only includes non-code changes, like changes to documentation, README, etc.

Copy link

changeset-bot bot commented Apr 21, 2024

🦋 Changeset detected

Latest commit: 178e3be

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@guildedjs/api Patch
guilded.js Patch
@guildedjs/gil Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor Author

@IdkGoodName IdkGoodName left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not related to the PR as much, but I also believe we could just modify the client options to use RestOptions and WebSocketOptions for rest and ws properties respectively, since it's directly given to RestManager and WebSocketManager. Otherwise, there may be hacky casts.

@IdkGoodName
Copy link
Contributor Author

IdkGoodName commented Apr 21, 2024

Sorta requested by @zaida04.

@zaida04 zaida04 merged commit 7158c2c into zaida04:main Apr 21, 2024
3 checks passed
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