From 390ed8d0f15ee3915e35ccea5505890b10f16c81 Mon Sep 17 00:00:00 2001 From: mshanemc Date: Fri, 5 Feb 2021 08:38:58 -0600 Subject: [PATCH] fix: update password jsdoc for v51 + return type --- src/user.ts | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/user.ts b/src/user.ts index a7f0052c63..6be3e3e3fa 100644 --- a/src/user.ts +++ b/src/user.ts @@ -241,12 +241,15 @@ export class User extends AsyncCreatable { /** * Assigns a password to a user. For a user to have the ability to assign their own password, the org needs the - * following org preference: SelfSetPasswordInApi. + * following org feature: SelfSetPasswordInApi. * * @param info The AuthInfo object for user to assign the password to. * @param password [throwWhenRemoveFails = User.generatePasswordUtf8()] A SecureBuffer containing the new password. */ - public async assignPassword(info: AuthInfo, password: SecureBuffer = User.generatePasswordUtf8()) { + public async assignPassword( + info: AuthInfo, + password: SecureBuffer = User.generatePasswordUtf8() + ): Promise { this.logger.debug( `Attempting to set password for userId: ${info.getFields().userId} username: ${info.getFields().username}` );