auth: Deprecate getEmail()

Change-type: patch
balena-io · Aug 10, 2023 · afeb38b · afeb38b
1 parent fdcdc6e
commit afeb38b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -432,7 +432,7 @@ const sdk = fromSharedOptions();
         * [.getUserInfo()](#balena.auth.getUserInfo) ⇒ <code>Promise</code>
         * [.getUserId()](#balena.auth.getUserId) ⇒ <code>Promise</code>
         * [.getUserActorId()](#balena.auth.getUserActorId) ⇒ <code>Promise</code>
-        * [.getEmail()](#balena.auth.getEmail) ⇒ <code>Promise</code>
+        * ~~[.getEmail()](#balena.auth.getEmail) ⇒ <code>Promise</code>~~
         * [.logout()](#balena.auth.logout) ⇒ <code>Promise</code>
         * [.register(credentials)](#balena.auth.register) ⇒ <code>Promise</code>
         * [.verifyEmail(verificationPayload)](#balena.auth.verifyEmail) ⇒ <code>Promise</code>
@@ -6487,7 +6487,7 @@ balena.models.billing.downloadInvoice(orgId, '0000').then(function(stream) {
     * [.getUserInfo()](#balena.auth.getUserInfo) ⇒ <code>Promise</code>
     * [.getUserId()](#balena.auth.getUserId) ⇒ <code>Promise</code>
     * [.getUserActorId()](#balena.auth.getUserActorId) ⇒ <code>Promise</code>
-    * [.getEmail()](#balena.auth.getEmail) ⇒ <code>Promise</code>
+    * ~~[.getEmail()](#balena.auth.getEmail) ⇒ <code>Promise</code>~~
     * [.logout()](#balena.auth.logout) ⇒ <code>Promise</code>
     * [.register(credentials)](#balena.auth.register) ⇒ <code>Promise</code>
     * [.verifyEmail(verificationPayload)](#balena.auth.verifyEmail) ⇒ <code>Promise</code>
@@ -6789,7 +6789,9 @@ balena.auth.getUserActorId().then(function(userActorId) {
 ```
 <a name="balena.auth.getEmail"></a>
 
-#### auth.getEmail() ⇒ <code>Promise</code>
+#### ~~auth.getEmail() ⇒ <code>Promise</code>~~
+***Deprecated***
+
 This will only work if you used [login](#balena.auth.login) to log in.
 
 **Kind**: static method of [<code>auth</code>](#balena.auth)  

diff --git a/src/auth.ts b/src/auth.ts
@@ -373,6 +373,7 @@ const getAuth = function (
 	 * @public
 	 * @function
 	 * @memberof balena.auth
+	 * @deprecated use balena.auth.getUserInfo()
 	 *
 	 * @description This will only work if you used {@link balena.auth.login} to log in.
 	 *