Improve Web API method argument types #505
Labels
area:typescript
issues that specifically impact using the package from typescript projects
enhancement
M-T: A feature request for new functionality
good first issue
We're looking for your help!
In TypeScript, its really helpful to get code completion hints that are smart enough to know which arguments are possible to use with which Web API method (and which type that argument value should be). It can save you time jumping between your editor and the documentation on api.slack.com.
Here's an example:
But this only works for methods where the arguments are typed in
src/methods.ts
. If we get all the Web API methods completed, we can even offer error highlighting when you misspell an argument name or pass an additional argument that isn't actually accepted.There's over 130 Web API methods, so it's not fun for one person to do all the work. This is a call for our community to come help get all the method's arguments typed.
If you're willing to help, pick a family of methods from the list below and comment on this ticket.
conversations.*
dialog.*
dnd.*
emoji.*
files.*
groups.*
im.*
migration.*
mpim.*
pins.*
reactions.*
reminders.*
rtm.*
search.*
stars.*
team.*
usergroups.*
You'll find many method families that are already complete, which can be a guide on how we expect the definitions to look. If you're not sure, that's okay, just ask!
Requirements (place an
x
in each of the[ ]
)The text was updated successfully, but these errors were encountered: