dropbox / dropbox-sdk-js

The Official Dropbox API V2 SDK for Javascript
https://www.dropbox.com/developers
MIT License
942 stars 353 forks source link

Incorrect typescript definitions #1128

Open wolfgangmeyers opened 1 year ago

wolfgangmeyers commented 1 year ago

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

Additional context Add any other context about the problem here.

greg-db commented 1 year ago

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