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

UserChangeEvent.user.updated should be typed as a number #1320

Closed
4 of 10 tasks
pmezard opened this issue Feb 16, 2022 · 2 comments · Fixed by #1322
Closed
4 of 10 tasks

UserChangeEvent.user.updated should be typed as a number #1320

pmezard opened this issue Feb 16, 2022 · 2 comments · Fixed by #1322
Assignees
Labels
bug M-T: confirmed bug report. Issues are confirmed when the reproduction steps are documented
Milestone

Comments

@pmezard
Copy link

pmezard commented Feb 16, 2022

Description

The attribute UserChangeEvent.user.updated here:

https://github.com/slackapi/bolt-js/blob/main/src/types/events/base-events.ts#L796

should have the type number, as it is in web-api definition:

https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/response/UsersListResponse.ts#L41

(Also, as mentioned by a TODO, UserChangeEvent.user definition should probably be shared with TeamJoin.user, short of pulling the definition from web-api. But I guess this is a larger change).

What type of issue is this? (place an x in one of the [ ])

  • bug
  • enhancement (feature request)
  • question
  • documentation related
  • example code related
  • testing related
  • discussion

Requirements (place an x in each of the [ ])

  • I've read and understood the Contributing guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've searched for any related issues and avoided creating a duplicate issue.
@mwbrooks mwbrooks added the bug M-T: confirmed bug report. Issues are confirmed when the reproduction steps are documented label Feb 16, 2022
@mwbrooks
Copy link
Member

Hey @pmezard, thanks for creating this issue 🙇🏻

I've labelled this as a bug and we can keep it open to track updating the type. A question that we'll want to answer is whether this will cause problems for existing developers expecting a string type.

@mwbrooks
Copy link
Member

Talking it over with the maintainers, we don't see any major side effects and changing this type should be fine.

@seratch seratch added this to the 3.10.0 milestone Feb 18, 2022
@seratch seratch self-assigned this Feb 18, 2022
seratch added a commit to seratch/bolt-js that referenced this issue Feb 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug M-T: confirmed bug report. Issues are confirmed when the reproduction steps are documented
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants