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(ClientEvents): add tuple labels to event arguments #5225

Merged
merged 1 commit into from Jan 22, 2021
Merged

feat(ClientEvents): add tuple labels to event arguments #5225

merged 1 commit into from Jan 22, 2021

Conversation

ElCholoGamer
Copy link
Contributor

@ElCholoGamer ElCholoGamer commented Jan 18, 2021

Adds labels to the tuple types in the ClientEvents interface (typings). These labels will appear as argument names when using IntelliSense, instead of 'args_0', 'args_1', etc. They will be helpful for knowing exactly what each argument represents, mostly in update events (which pass the 'old' and 'new' version of the object), and shard events (which pass the shard ID).

Although most labels are self-explanatory, some other may need slight changes to be more accurate.

Status

  • Code changes have been tested against the Discord API, or there are no code changes
  • I know how to update typings and have done so, or typings don't need updating

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.

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.

Parameter name on the code is different with jsDocs in Client#channelUpdate
5 participants