Add comments to onyx types

Expensify · Oct 20, 2023 · e2f5dc7 · e2f5dc7
1 parent cdb976d
commit e2f5dc7
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/types/onyx/Credentials.ts b/src/types/onyx/Credentials.ts
@@ -1,17 +1,29 @@
 type Credentials = {
     /** The email/phone the user logged in with */
     login?: string;
+
+    /** The password the user logged in with */
     password?: string;
+
+    /** The two factor auth code */
     twoFactorAuthCode?: string;
 
     /** The validate code */
     validateCode?: string;
 
+    /** The auto-generated login. */
     autoGeneratedLogin?: string;
+
+    /** The auto-generated password. */
     autoGeneratedPassword?: string;
+
+    /** The user's ID */
     accountID?: number;
 
+    /** The user's ID for external integration */
     partnerUserID?: string;
+
+    /** The user's secret for external integration */
     partnerUserSecret?: string;
 };
 

diff --git a/src/types/onyx/Session.ts b/src/types/onyx/Session.ts
@@ -11,8 +11,10 @@ type Session = {
     /** Currently logged in user authToken */
     authToken?: string;
 
+    /** Currently logged in user authToken type */
     authTokenType?: string;
 
+    /** Currently logged in user support authToken */
     supportAuthToken?: string;
 
     /** Currently logged in user encrypted authToken */