refactor: use interfaces for AsyncEventEmitter event maps #10044
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Qjuh
requested review from
vladfrangu,
didinele,
ckohen,
kyranet,
Jiralite and
SpaceEEC
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 2 Ignored Deployments
|
github-actions
bot
added
packages:rest
packages:ws
packages:brokers
packages:core
labels
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10044 +/- ##
==========================================
+ Coverage 58.34% 58.36% +0.02%
==========================================
Files 241 241
Lines 17158 17168 +10
Branches 1242 1242
==========================================
+ Hits 10010 10020 +10
Misses 7103 7103
Partials 45 45
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
vladfrangu
approved these changes
Dec 10, 2023
didinele
requested changes
Dec 10, 2023
didinele
approved these changes
Dec 10, 2023
ckohen
requested changes
Dec 11, 2023
ckohen
approved these changes
Dec 11, 2023
iCrawl
approved these changes
Dec 14, 2023
Vylpes
pushed a commit
to Vylpes/card-drop
that referenced
this pull request
May 20, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@discordjs/rest](https://discord.js.org) ([source](https://github.com/discordjs/discord.js)) | dependencies | minor | [`2.2.0` -> `2.3.0`](https://renovatebot.com/diffs/npm/@discordjs%2frest/2.2.0/2.3.0) | --- ### Release Notes <details> <summary>discordjs/discord.js (@​discordjs/rest)</summary> ### [`v2.3.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/rest/CHANGELOG.md#discordjsrest230---2024-05-04) [Compare Source](https://github.com/discordjs/discord.js/compare/@discordjs/[email protected]...@discordjs/[email protected]) #### Bug Fixes - Anchor link for events ([0efd1be](discordjs/discord.js@0efd1be)) #### Documentation - Split docs.api.json into multiple json files ([597340f](discordjs/discord.js@597340f)) - Remove hyphen after `@returns` ([#​9989](discordjs/discord.js#9989)) ([e9ff991](discordjs/discord.js@e9ff991)) #### Features - Local and preview detection ([79fbda3](discordjs/discord.js@79fbda3)) - **REST:** Dynamic rate limit offsets ([#​10099](discordjs/discord.js#10099)) ([278396e](discordjs/discord.js@278396e)) #### Refactor - Docs ([#​10126](discordjs/discord.js#10126)) ([18cce83](discordjs/discord.js@18cce83)) - Use interfaces for AsyncEventEmitter event maps ([#​10044](discordjs/discord.js#10044)) ([adfd9cd](discordjs/discord.js@adfd9cd)) #### Styling - Fix up lint ([d869d9b](discordjs/discord.js@d869d9b)) #### Testing - Skip flaky rest test ([#​10234](discordjs/discord.js#10234)) ([dc8f149](discordjs/discord.js@dc8f149)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=--> Reviewed-on: https://git.vylpes.xyz/External/card-drop/pulls/232 Reviewed-by: Vylpes <[email protected]> Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>
Vylpes
pushed a commit
to Vylpes/vylbot-app
that referenced
this pull request
Jun 25, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@discordjs/rest](https://discord.js.org) ([source](https://github.com/discordjs/discord.js)) | dependencies | minor | [`2.2.0` -> `2.3.0`](https://renovatebot.com/diffs/npm/@discordjs%2frest/2.2.0/2.3.0) | --- ### Release Notes <details> <summary>discordjs/discord.js (@​discordjs/rest)</summary> ### [`v2.3.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/rest/CHANGELOG.md#discordjsrest230---2024-05-04) [Compare Source](https://github.com/discordjs/discord.js/compare/@discordjs/[email protected]...@discordjs/[email protected]) #### Bug Fixes - Anchor link for events ([0efd1be](discordjs/discord.js@0efd1be)) #### Documentation - Split docs.api.json into multiple json files ([597340f](discordjs/discord.js@597340f)) - Remove hyphen after `@returns` ([#​9989](discordjs/discord.js#9989)) ([e9ff991](discordjs/discord.js@e9ff991)) #### Features - Local and preview detection ([79fbda3](discordjs/discord.js@79fbda3)) - **REST:** Dynamic rate limit offsets ([#​10099](discordjs/discord.js#10099)) ([278396e](discordjs/discord.js@278396e)) #### Refactor - Docs ([#​10126](discordjs/discord.js#10126)) ([18cce83](discordjs/discord.js@18cce83)) - Use interfaces for AsyncEventEmitter event maps ([#​10044](discordjs/discord.js#10044)) ([adfd9cd](discordjs/discord.js@adfd9cd)) #### Styling - Fix up lint ([d869d9b](discordjs/discord.js@d869d9b)) #### Testing - Skip flaky rest test ([#​10234](discordjs/discord.js#10234)) ([dc8f149](discordjs/discord.js@dc8f149)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=--> Reviewed-on: https://git.vylpes.xyz/RabbitLabs/vylbot-app/pulls/435 Reviewed-by: Vylpes <[email protected]> Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please describe the changes this PR makes and why it should be merged:
Turn the mapped types for events in
rest/REST,ws/WebSocketManager,ws/WebSocketShardandcore/Clientinto interfaces for better documentation purposes.Also turns
WebSocketManagerOptionsinto an interface for the same reason.Some interfaces are simple aliases of already existing interfaces, to keep the named export and make this possible as a non-breaking change even in TS land.
@discordjs/brokersstill uses types for event maps, but they are dynamic so not as easily adjustable.Status and versioning classification: