Skip to content

Incorrect typescript definitions #1128

@wolfgangmeyers

Description

@wolfgangmeyers

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions