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

Improve Web API method argument types #505

Closed
3 of 20 tasks
aoberoi opened this issue Mar 14, 2018 · 1 comment
Closed
3 of 20 tasks

Improve Web API method argument types #505

aoberoi opened this issue Mar 14, 2018 · 1 comment
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

Comments

@aoberoi
Copy link
Contributor

aoberoi commented Mar 14, 2018

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:

code completion

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 [ ])

  • 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.
@aoberoi aoberoi added good first issue enhancement M-T: A feature request for new functionality area:typescript issues that specifically impact using the package from typescript projects labels Mar 14, 2018
@clavin
Copy link
Contributor

clavin commented Mar 16, 2018

I have a few spare hours that I could spend twiddling my thumbs, so I figure I can do all of these instead. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

2 participants