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

Incorrect typescript definitions #1128

Open
wolfgangmeyers opened this issue Jul 27, 2023 · 1 comment
Open

Incorrect typescript definitions #1128

wolfgangmeyers opened this issue Jul 27, 2023 · 1 comment
Labels

Comments

@wolfgangmeyers
Copy link

Describe the bug
The typescript definitions for some of the functions in DropboxAuth are incorrect. They return void, but the docs on the function indicate that the functions return a Promise.

To Reproduce
Try compiling code that uses checkAndRefreshAccessToken or refreshAccessToken as functions that return Promises.

Expected Behavior
These functions should have type definitions that return a Promise

Actual Behavior
The functions instead have a void return type.

Screenshots
Here's a snippet of the DropboxAuth type definitions:

  /**
   * Checks if a token is needed, can be refreshed and if the token is expired.
   * If so, attempts to refresh access token
   * @returns {Promise<*>}
   */
  checkAndRefreshAccessToken(): void;

  /**
   * Refreshes the access token using the refresh token, if available
   * @arg {List} scope - a subset of scopes from the original
   * refresh to acquire with an access token
   * @returns {Promise<*>}
   */
  refreshAccessToken(scope?: Array<String>): void;

Versions

  • What version of the SDK are you using? 10.34.0
  • What version of the language are you using? Irrelevant
  • Are you using Javascript or Typescript? Typescript
  • What platform are you using? (if applicable) Vercel

Additional context
Add any other context about the problem here.

@greg-db
Copy link
Contributor

greg-db commented Jul 27, 2023

Thanks for the report! I've asked the team to fix that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants