Skip to content

Commit

Permalink
Updated jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Ramon Candel authored and Ramon Candel committed Jun 14, 2024
1 parent 731c8bb commit cc817cd
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/drive/users/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,18 @@ export class Users {
}

/**
* Returns user data
* Retrieves the user data for a specific user identified by the uuid.
*
* @param {string} params.userUuid - The UUID of the user.
* @return {Promise<Object>} A promise that resolves to an object containing the user data.
* The object has the following properties:
* - `newToken` (string): The new token of the user.
* - `oldToken` (string): The old drive token of the user.
* - `user` (UserSettings): The user data.
*/
public getUserData({ userUuid }: { userUuid: string }): Promise<{
newToken: string;
oldToken: string;
user: UserSettings;
}> {
return this.client.get(`/users/c/${userUuid}`, this.headers());
Expand Down

0 comments on commit cc817cd

Please sign in to comment.