fix: add tsdocs

supabase · Mar 5, 2024 · 02080a6 · 02080a6
1 parent 889a462
commit 02080a6
Showing 1 changed file with 13 additions and 7 deletions.
diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -366,7 +366,7 @@ export interface UserAttributes {
   nonce?: string
 
   /**
-   * A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
+   * A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.
    *
    * The `data` should be a JSON object that includes user-specific info, such as their first and last name.
    *
@@ -376,7 +376,7 @@ export interface UserAttributes {
 
 export interface AdminUserAttributes extends Omit<UserAttributes, 'data'> {
   /**
-   * A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
+   * A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.
    *
    *
    * The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.
@@ -454,7 +454,13 @@ export interface UpdatableFactorAttributes {
 
 export type SignInAnonymouslyCredentials = {
   options?: {
+    /**
+     * A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.
+     *
+     * The `data` should be a JSON object that includes user-specific info, such as their first and last name.
+     */
     data?: object
+    /** Verification token received when the user completes the captcha on the site. */
     captchaToken?: string
   }
 }
@@ -469,7 +475,7 @@ export type SignUpWithPasswordCredentials =
         /** The redirect url embedded in the email link */
         emailRedirectTo?: string
         /**
-         * A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
+         * A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.
          *
          * The `data` should be a JSON object that includes user-specific info, such as their first and last name.
          */
@@ -485,7 +491,7 @@ export type SignUpWithPasswordCredentials =
       password: string
       options?: {
         /**
-         * A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
+         * A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.
          *
          * The `data` should be a JSON object that includes user-specific info, such as their first and last name.
          */
@@ -528,7 +534,7 @@ export type SignInWithPasswordlessCredentials =
         /** If set to false, this method will not create a new user. Defaults to true. */
         shouldCreateUser?: boolean
         /**
-         * A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
+         * A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.
          *
          * The `data` should be a JSON object that includes user-specific info, such as their first and last name.
          */
@@ -544,7 +550,7 @@ export type SignInWithPasswordlessCredentials =
         /** If set to false, this method will not create a new user. Defaults to true. */
         shouldCreateUser?: boolean
         /**
-         * A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
+         * A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.
          *
          * The `data` should be a JSON object that includes user-specific info, such as their first and last name.
          */
@@ -715,7 +721,7 @@ export type GenerateEmailChangeLinkParams = {
 
 export interface GenerateLinkOptions {
   /**
-   * A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
+   * A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.
    *
    * The `data` should be a JSON object that includes user-specific info, such as their first and last name.
    */