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

docs: correctly type getters #7500

Merged
merged 1 commit into from
Feb 20, 2022
Merged

docs: correctly type getters #7500

merged 1 commit into from
Feb 20, 2022

Conversation

IRONM00N
Copy link
Contributor

Please describe the changes this PR makes and why it should be merged:

  • made all getters be typed correctly as getters - this improves typescript error messages and makes it clearer to the end-user that the value is calculated
  • remove GuildChannel#calculatedPosition from the typings since it doesn't exist in the source code
  • corrected a few properties that should(n't) have been marked as readonly

Status and versioning classification:

  • 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
  • This PR only includes non-code changes, like changes to documentation, README, etc.

Copy link
Member

@kyranet kyranet left a comment

Choose a reason for hiding this comment

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

This was a task that I wanted to get done for a while, thanks! 🙏🏼

@iCrawl iCrawl merged commit ffecf08 into discordjs:main Feb 20, 2022
@IRONM00N IRONM00N deleted the correct-getter-typings branch February 20, 2022 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants